Portfolio_Management_Utilities.md

graph LR
    Portfolio_Core["Portfolio Core"]
    Portfolio_Population["Portfolio Population"]
    Pre_selection_Transformers["Pre-selection Transformers"]
    General_Utilities["General Utilities"]
    Sorting_Utilities["Sorting Utilities"]
    Equation_Parsing["Equation Parsing"]
    Portfolio_Measures["Portfolio Measures"]
    Exception_Handling["Exception Handling"]
    Portfolio_Core -- "utilizes" --> Portfolio_Measures
    Portfolio_Core -- "utilizes" --> General_Utilities
    Portfolio_Core -- "utilizes" --> Sorting_Utilities
    Portfolio_Population -- "contains instances of" --> Portfolio_Core
    Portfolio_Population -- "leverages" --> Sorting_Utilities
    Pre_selection_Transformers -- "operates on" --> Portfolio_Population
    Pre_selection_Transformers -- "creates and manipulates" --> Portfolio_Population
    Equation_Parsing -- "interacts with" --> Exception_Handling

Loading

Details

Portfolio Management & Utilities subsystem

Portfolio Core

Encapsulates the fundamental definitions and behaviors of investment portfolios, including abstract base classes and concrete implementations for single and multi-period portfolios. It ensures a consistent interface for all portfolio objects.

Related Classes/Methods:

• skfolio.portfolio._base.BasePortfolio (73:1206)
• skfolio.portfolio._portfolio.Portfolio (1:1)
• skfolio.portfolio._multi_period_portfolio.MultiPeriodPortfolio (1:1)

Portfolio Population

Manages collections of Portfolio objects, serving as a container for groups of portfolios, particularly relevant for pre-selection and analysis of multiple portfolio candidates.

Related Classes/Methods:

• skfolio.population._population.Population (1:1)

Pre-selection Transformers

Provides Scikit-learn compatible transformers that implement various strategies for filtering and selecting portfolios from a Portfolio Population based on defined criteria (e.g., selecting extremes or non-dominated portfolios).

Related Classes/Methods:

• skfolio.pre_selection.SelectKExtremes (1:1)
• skfolio.pre_selection.SelectNonDominated (1:1)

General Utilities

A module offering a collection of general-purpose utility functions for data validation, argument handling, formatting, and Scikit-learn-compatible helpers, promoting code reusability across the library.

Related Classes/Methods:

• skfolio.utils.tools

Sorting Utilities

Implements specialized sorting algorithms, particularly those relevant to multi-objective optimization concepts such as Pareto dominance, used for ordering and ranking portfolios.

Related Classes/Methods:

• skfolio.utils.sorting

Equation Parsing

Responsible for parsing and converting string-based equations and group cardinalities into matrix representations, primarily used for defining and handling constraints in optimization problems.

Related Classes/Methods:

• skfolio.utils.equations

Portfolio Measures

Provides a suite of functions for calculating various quantitative measures and metrics associated with portfolios, such as risk, return, and performance indicators.

Related Classes/Methods:

• skfolio.utils.measures (1:1)

Exception Handling

Manages and defines custom exception types and error handling mechanisms specific to the skfolio library, ensuring robust error reporting and system stability.

Related Classes/Methods:

• skfolio.utils.exceptions (1:1)

FAQ