Python pacakge to flatten and fold parameter data structures.
This is a library (very much still in development) intended to make sensitivity analysis easier for optimization problems. The core functionality consists of tools for “folding” and “flattening” collections of parameters – i.e., for converting data structures of constrained parameters to and from vectors of unconstrained parameters.
For background and motivation, see the following papers:
Using the package.
We welcome new users! However, please be aware that the package is still in development. We encourage users to contact the author (github user rgiordan) for advice, bugs, or if you’re using the package for something important.
The package is not (yet) registered on pypi. To install, run the following command, pointing to the root of the git repo:
sudo -H pip3 install --user -e paragami.
Documentation and Examples.
For API documentation, see readthedocs.
Alternatively, check out the repo and run make html in docs/.
For motivating and expository Jupyter notebooks, see docs/example_notebooks/. A good place to start is docs/example_notebooks/front_page_example.ipynb.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.