.. pipefolio documentation master file, created by
   sphinx-quickstart on Sat Jan 11 13:33:10 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pipefolio documentation
=======================

.. image:: https://raw.githubusercontent.com/kfuangsung/pipefolio/refs/heads/main/docs/_static/pipefolio-logo.png

**Pipefolio** is a Python-based portfolio optimization framework designed with a pipeline-oriented approach. While several excellent Python libraries for portfolio optimization already exist—such as `PyPortfolioOpt <https://github.com/robertmartin8/PyPortfolioOpt>`_, `Riskfolio-Lib <https://github.com/dcajasn/Riskfolio-Lib>`_, and `skfolio <https://github.com/skfolio/skfolio>`_—Pipefolio takes a different direction.

Built on top of `scikit-learn <https://scikit-learn.org/stable/>`_, Pipefolio leverages existing optimization algorithms while minimizing boilerplate code through the use of the **pipe (|) operator**, enabling a streamlined and efficient workflow.

The framework provides the following types of models, each serving a specific purpose in the portfolio optimization process:


.. toctree::
   :maxdepth: 2
   :caption: Contents: