skfolio 0.0.11__tar.gz → 0.1.0__tar.gz

{skfolio-0.0.11/src/skfolio.egg-info → skfolio-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: skfolio
-Version: 0.0.11
+Version: 0.1.0
 Summary: Portfolio optimization built on top of scikit-learn
 Author-email: Hugo Delatte <delatte.hugo@gmail.com>
 Maintainer-email: Hugo Delatte <delatte.hugo@gmail.com>
@@ -86,7 +86,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 
 .. -*- mode: rst -*-
 
-|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Website|_
+|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Contribution|_ |Website|_
 
 .. |Licence| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
 .. _Licence: https://github.com/skfolio/skfolio/blob/main/LICENSE
@@ -112,7 +112,10 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 .. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 .. _Ruff: https://github.com/astral-sh/ruff
 
-.. |Website| image:: https://img.shields.io/website-up-down-green-red/http/skfolio.org
+.. |Contribution| image:: https://img.shields.io/badge/Contributions-Welcome-blue
+.. _Contribution: https://github.com/skfolio/skfolio/blob/main/CONTRIBUTING.md
+
+.. |Website| image:: https://img.shields.io/website-up-down-53cc0d-red/http/skfolio.org
 .. _Website: https://skfolio.org
 
 .. |PythonMinVersion| replace:: 3.10
@@ -128,7 +131,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 ===============
 |icon|  skfolio
 ===============
-.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/favicon.png
+.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/logo_animate.svg
     :width: 100
     :alt: skfolio documentation
     :target: https://skfolio.org/

{skfolio-0.0.11 → skfolio-0.1.0}/README.rst

@@ -1,6 +1,6 @@
 .. -*- mode: rst -*-
 
-|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Website|_
+|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Contribution|_ |Website|_
 
 .. |Licence| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
 .. _Licence: https://github.com/skfolio/skfolio/blob/main/LICENSE
@@ -26,7 +26,10 @@
 .. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 .. _Ruff: https://github.com/astral-sh/ruff
 
-.. |Website| image:: https://img.shields.io/website-up-down-green-red/http/skfolio.org
+.. |Contribution| image:: https://img.shields.io/badge/Contributions-Welcome-blue
+.. _Contribution: https://github.com/skfolio/skfolio/blob/main/CONTRIBUTING.md
+
+.. |Website| image:: https://img.shields.io/website-up-down-53cc0d-red/http/skfolio.org
 .. _Website: https://skfolio.org
 
 .. |PythonMinVersion| replace:: 3.10
@@ -42,7 +45,7 @@
 ===============
 |icon|  skfolio
 ===============
-.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/favicon.png
+.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/logo_animate.svg
     :width: 100
     :alt: skfolio documentation
     :target: https://skfolio.org/

{skfolio-0.0.11 → skfolio-0.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "skfolio"
-version = "0.0.11"
+version = "0.1.0"
 maintainers = [
     { name = "Hugo Delatte", email = "delatte.hugo@gmail.com" },
 ]

{skfolio-0.0.11 → skfolio-0.1.0}/src/skfolio/measures/_measures.py

@@ -608,3 +608,28 @@ def gini_mean_difference(returns: np.ndarray) -> float:
     """
     w = owa_gmd_weights(len(returns))
     return float(w @ np.sort(returns, axis=0))
+
+
+def effective_number_assets(weights: np.ndarray) -> float:
+    r"""
+    Computes the effective number of assets, defined as the inverse of the Herfindahl index [1]_:
+    .. math:: N_{eff} = \frac{1}{\Vert w \Vert_{2}^{2}}
+
+    It quantifies portfolio concentration, with a higher value indicating a more diversified portfolio.
+
+    Parameters
+    ----------
+    weights : ndarray of shape (n_assets,)
+        Weights of the assets.
+
+    Returns
+    -------
+    value : float
+        Effective number of assets.
+
+    References
+    ----------
+    .. [1] "Banking and Financial Institutions Law in a Nutshell".
+        Lovett, William Anthony (1988)
+    """
+    return 1.0 / (np.power(weights, 2).sum())

{skfolio-0.0.11 → skfolio-0.1.0}/src/skfolio/portfolio/_base.py

@@ -369,7 +369,6 @@ class BasePortfolio:
     _read_only_attrs: ClassVar[set] = {
         "returns",
         "observations",
-        "n_observations",
     }
 
     # Arguments globally used in measures computation
@@ -401,7 +400,6 @@ class BasePortfolio:
         # public read-only
         "returns",
         "observations",
-        "n_observations",
         # private
         "_loaded",
         # custom getter and setter
@@ -521,7 +519,6 @@ class BasePortfolio:
             self._fitness_measures = [PerfMeasure.MEAN, RiskMeasure.VARIANCE]
         else:
             self._fitness_measures = fitness_measures
-        self.n_observations = len(observations)
         self._loaded = True
 
     def __reduce__(self):
@@ -531,9 +528,6 @@ class BasePortfolio:
             [getattr(self, arg) for arg in args_names(self.__init__)]
         )
 
-    def __len__(self) -> int:
-        return len(self.observations)
-
     def __repr__(self) -> str:
         return f"<{type(self).__name__} {self.name}>"
 
@@ -679,6 +673,11 @@ class BasePortfolio:
         return mt.get_drawdowns(returns=self.returns, compounded=self.compounded)
 
     # Classic property
+    @property
+    def n_observations(self) -> int:
+        """Number of observations"""
+        return len(self.observations)
+
     @property
     def returns_df(self) -> pd.Series:
         """Portfolio returns DataFrame."""

{skfolio-0.0.11 → skfolio-0.1.0}/src/skfolio/portfolio/_multi_period_portfolio.py

@@ -369,6 +369,9 @@ class MultiPeriodPortfolio(BasePortfolio):
         self.check_observations_order = check_observations_order
         self._set_portfolios(portfolios=portfolios)
 
+    def __len__(self) -> int:
+        return len(self.portfolios)
+
     def __getitem__(self, key: int | slice) -> Portfolio | list[Portfolio]:
         return self._portfolios[key]
 
@@ -571,12 +574,12 @@ class MultiPeriodPortfolio(BasePortfolio):
         """
         df = super().summary(formatted=formatted)
         portfolios_number = len(self)
-        avg_assets_per_portfolio = np.mean([len(p) for p in self])
+        avg_assets_per_portfolio = np.mean([p.n_assets for p in self])
         if formatted:
             portfolios_number = str(int(portfolios_number))
             avg_assets_per_portfolio = f"{avg_assets_per_portfolio:0.1f}"
-        df["Portfolios number"] = portfolios_number
-        df["Avg nb of assets per portfolio"] = avg_assets_per_portfolio
+        df["Portfolios Number"] = portfolios_number
+        df["Avg nb of Assets per Portfolio"] = avg_assets_per_portfolio
         return df
 
     # Public methods

{skfolio-0.0.11 → skfolio-0.1.0}/src/skfolio/utils/fixes/_dendrogram.py

@@ -290,15 +290,13 @@ class _Dendrogram:
         Sets and returns default layout object for dendrogram figure.
 
         """
-        self.layout.update(
-            {
-                "showlegend": False,
-                "autosize": False,
-                "hovermode": "closest",
-                "width": width,
-                "height": height,
-            }
-        )
+        self.layout.update({
+            "showlegend": False,
+            "autosize": False,
+            "hovermode": "closest",
+            "width": width,
+            "height": height,
+        })
 
         self.set_axis_layout(self.xaxis)
         self.set_axis_layout(self.yaxis)

{skfolio-0.0.11 → skfolio-0.1.0/src/skfolio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: skfolio
-Version: 0.0.11
+Version: 0.1.0
 Summary: Portfolio optimization built on top of scikit-learn
 Author-email: Hugo Delatte <delatte.hugo@gmail.com>
 Maintainer-email: Hugo Delatte <delatte.hugo@gmail.com>
@@ -86,7 +86,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 
 .. -*- mode: rst -*-
 
-|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Website|_
+|Licence|_ |Codecov|_ |Black|_ |PythonVersion|_ |PyPi|_ |CI/CD|_ |Downloads|_ |Ruff|_ |Contribution|_ |Website|_
 
 .. |Licence| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
 .. _Licence: https://github.com/skfolio/skfolio/blob/main/LICENSE
@@ -112,7 +112,10 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 .. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 .. _Ruff: https://github.com/astral-sh/ruff
 
-.. |Website| image:: https://img.shields.io/website-up-down-green-red/http/skfolio.org
+.. |Contribution| image:: https://img.shields.io/badge/Contributions-Welcome-blue
+.. _Contribution: https://github.com/skfolio/skfolio/blob/main/CONTRIBUTING.md
+
+.. |Website| image:: https://img.shields.io/website-up-down-53cc0d-red/http/skfolio.org
 .. _Website: https://skfolio.org
 
 .. |PythonMinVersion| replace:: 3.10
@@ -128,7 +131,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 ===============
 |icon|  skfolio
 ===============
-.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/favicon.png
+.. |icon| image:: https://raw.githubusercontent.com/skfolio/skfolio/master/docs/_static/logo_animate.svg
     :width: 100
     :alt: skfolio documentation
     :target: https://skfolio.org/