entropy-pooling


Nameentropy-pooling JSON
Version 1.0.4 PyPI version JSON
download
home_pagehttps://fortitudo.tech
SummaryEntropy Pooling in Python with a BSD 3-Clause license.
upload_time2024-04-25 11:17:54
maintainerNone
docs_urlNone
authorFortitudo Technologies
requires_python<3.13,>=3.9
licenseBSD-3-Clause
keywords entropy pooling quantitative finance monte carlo stress-testing cvar
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pytest](https://github.com/fortitudo-tech/entropy-pooling/actions/workflows/tests.yml/badge.svg)](https://github.com/fortitudo-tech/entropy-pooling/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/fortitudo-tech/entropy-pooling/graph/badge.svg?token=XGIQ78ZLDN)](https://codecov.io/gh/fortitudo-tech/entropy-pooling)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fortitudo-tech/entropy-pooling/HEAD?labpath=examples)

Entropy Pooling in Python
=========================

Due to popular demand from developers, this package contains the Entropy Pooling
implementation from the [fortitudo.tech Python package](https://github.com/fortitudo-tech/fortitudo.tech)
with a more permissive BSD 3-Clause license.

This package contains only one function called ep and has minimal dependencies
with just scipy. See [this example](https://github.com/fortitudo-tech/entropy-pooling/blob/main/example/EntropyPooling.ipynb)
for how you can import and use the ep function.

You can explore the example without local installations using
[Binder](https://mybinder.org/v2/gh/fortitudo-tech/entropy-pooling/HEAD?labpath=examples).

Installation instructions
-------------------------

Installation can be done via pip:

    pip install entropy-pooling

Theory
------
Entropy Pooling is a powerful method for implementing subjective views and
performing stress-tests for fully general Monte Carlo distributions. It was first
introduced by [Meucci (2008)](https://ssrn.com/abstract=1213325) and refined
with sequential algorithms by [Vorobets (2021)](https://ssrn.com/abstract=3936392).

The original Entropy Pooling approach solves the minimum relative entropy problem

$$q=\underset{x}{\text{argmin}}\lbrace x^{T}\left(\ln x-\ln p\right)\rbrace$$

subject to the constraints

$$Gx\leq h \quad \text{and} \quad Ax=b.$$

The constraints matrices $A$ and $G$ contain transformations of the Monte Carlo
simulation that allow you to implement subjective views and stress-tests by
changing the joint scenario probabilities from a prior probability vector $p$
to a posterior probability vector $q$.

A useful statistic when working with Entropy Pooling is the effective number of
scenarios introduced by [Meucci (2012)](https://ssrn.com/abstract=1971808). For
a causal Bayesian nets overlay on top of Entropy Pooling, see
[Vorobets (2023)](https://ssrn.com/abstract=4444291).

Video walkthroughs
------------------

Video walkthroughs of the two notebook examples are available here https://youtu.be/hDt103zEML8
and here https://youtu.be/DK1Pv5tuLgo. The videos give additional insights into
Entropy Pooling theory and its sequential refinements. It is highly encouraged
to watch these two quickly increase your understanding.

Portfolio Construction and Risk Management Book
-----------------------------------------------

Entropy Pooling is a core part of the next generation investment framework that
also utilizes fully general Monte Carlo distributions and CVaR analysis, see
[this YouTube video](https://youtu.be/4ESigySdGf8?si) for an introduction. To
get a careful and pedagogical presentation of all the possibilities Entropy Pooling
offers, see the [Portfolio Construction and Risk Management Book](https://igg.me/at/pcrm-book)
crowdfunding campaign.

            

Raw data

            {
    "_id": null,
    "home_page": "https://fortitudo.tech",
    "name": "entropy-pooling",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": null,
    "keywords": "Entropy Pooling, Quantitative Finance, Monte Carlo, Stress-Testing, CVaR",
    "author": "Fortitudo Technologies",
    "author_email": "software@fortitudo.tech",
    "download_url": "https://files.pythonhosted.org/packages/26/28/720c6dcf6e1e9d39b8a904a1000cfa75575ff8f90af0bfb4ce7425201e2d/entropy_pooling-1.0.4.tar.gz",
    "platform": null,
    "description": "[![pytest](https://github.com/fortitudo-tech/entropy-pooling/actions/workflows/tests.yml/badge.svg)](https://github.com/fortitudo-tech/entropy-pooling/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/fortitudo-tech/entropy-pooling/graph/badge.svg?token=XGIQ78ZLDN)](https://codecov.io/gh/fortitudo-tech/entropy-pooling)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fortitudo-tech/entropy-pooling/HEAD?labpath=examples)\n\nEntropy Pooling in Python\n=========================\n\nDue to popular demand from developers, this package contains the Entropy Pooling\nimplementation from the [fortitudo.tech Python package](https://github.com/fortitudo-tech/fortitudo.tech)\nwith a more permissive BSD 3-Clause license.\n\nThis package contains only one function called ep and has minimal dependencies\nwith just scipy. See [this example](https://github.com/fortitudo-tech/entropy-pooling/blob/main/example/EntropyPooling.ipynb)\nfor how you can import and use the ep function.\n\nYou can explore the example without local installations using\n[Binder](https://mybinder.org/v2/gh/fortitudo-tech/entropy-pooling/HEAD?labpath=examples).\n\nInstallation instructions\n-------------------------\n\nInstallation can be done via pip:\n\n    pip install entropy-pooling\n\nTheory\n------\nEntropy Pooling is a powerful method for implementing subjective views and\nperforming stress-tests for fully general Monte Carlo distributions. It was first\nintroduced by [Meucci (2008)](https://ssrn.com/abstract=1213325) and refined\nwith sequential algorithms by [Vorobets (2021)](https://ssrn.com/abstract=3936392).\n\nThe original Entropy Pooling approach solves the minimum relative entropy problem\n\n$$q=\\underset{x}{\\text{argmin}}\\lbrace x^{T}\\left(\\ln x-\\ln p\\right)\\rbrace$$\n\nsubject to the constraints\n\n$$Gx\\leq h \\quad \\text{and} \\quad Ax=b.$$\n\nThe constraints matrices $A$ and $G$ contain transformations of the Monte Carlo\nsimulation that allow you to implement subjective views and stress-tests by\nchanging the joint scenario probabilities from a prior probability vector $p$\nto a posterior probability vector $q$.\n\nA useful statistic when working with Entropy Pooling is the effective number of\nscenarios introduced by [Meucci (2012)](https://ssrn.com/abstract=1971808). For\na causal Bayesian nets overlay on top of Entropy Pooling, see\n[Vorobets (2023)](https://ssrn.com/abstract=4444291).\n\nVideo walkthroughs\n------------------\n\nVideo walkthroughs of the two notebook examples are available here https://youtu.be/hDt103zEML8\nand here https://youtu.be/DK1Pv5tuLgo. The videos give additional insights into\nEntropy Pooling theory and its sequential refinements. It is highly encouraged\nto watch these two quickly increase your understanding.\n\nPortfolio Construction and Risk Management Book\n-----------------------------------------------\n\nEntropy Pooling is a core part of the next generation investment framework that\nalso utilizes fully general Monte Carlo distributions and CVaR analysis, see\n[this YouTube video](https://youtu.be/4ESigySdGf8?si) for an introduction. To\nget a careful and pedagogical presentation of all the possibilities Entropy Pooling\noffers, see the [Portfolio Construction and Risk Management Book](https://igg.me/at/pcrm-book)\ncrowdfunding campaign.\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Entropy Pooling in Python with a BSD 3-Clause license.",
    "version": "1.0.4",
    "project_urls": {
        "Documentation": "https://os.fortitudo.tech",
        "Homepage": "https://fortitudo.tech",
        "Issues": "https://github.com/fortitudo-tech/entropy-pooling/issues",
        "Repository": "https://github.com/fortitudo-tech/entropy-pooling"
    },
    "split_keywords": [
        "entropy pooling",
        " quantitative finance",
        " monte carlo",
        " stress-testing",
        " cvar"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c6897f3e42204ca64dda405d7e3ca19dcbd020ece5da742b7e85c69302ac0e7",
                "md5": "473da79bdc9f22ceb2aee5f1fb14760a",
                "sha256": "f8f3c50c5dc3e8c3ccf9be97d519ba5311c98dff1a6f5c9349c3c26844b27858"
            },
            "downloads": -1,
            "filename": "entropy_pooling-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "473da79bdc9f22ceb2aee5f1fb14760a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 5100,
            "upload_time": "2024-04-25T11:17:53",
            "upload_time_iso_8601": "2024-04-25T11:17:53.182331Z",
            "url": "https://files.pythonhosted.org/packages/9c/68/97f3e42204ca64dda405d7e3ca19dcbd020ece5da742b7e85c69302ac0e7/entropy_pooling-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2628720c6dcf6e1e9d39b8a904a1000cfa75575ff8f90af0bfb4ce7425201e2d",
                "md5": "5c405eb3b6dd8fe371ca071f92737679",
                "sha256": "90715277b372a153cbc0efd0cbd629ff625e9cf49d3923a063a841b9acb57ddf"
            },
            "downloads": -1,
            "filename": "entropy_pooling-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "5c405eb3b6dd8fe371ca071f92737679",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 4837,
            "upload_time": "2024-04-25T11:17:54",
            "upload_time_iso_8601": "2024-04-25T11:17:54.343977Z",
            "url": "https://files.pythonhosted.org/packages/26/28/720c6dcf6e1e9d39b8a904a1000cfa75575ff8f90af0bfb4ce7425201e2d/entropy_pooling-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 11:17:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fortitudo-tech",
    "github_project": "entropy-pooling",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "entropy-pooling"
}
        
Elapsed time: 0.22932s