Skip to main content

Python pacakge to flatten and fold parameter data structures.

Project description

# “Parameter origami”: paragami.

[![image](https://travis-ci.org/rgiordan/paragami.svg?branch=master)](https://travis-ci.org/rgiordan/paragami) [![image](https://codecov.io/gh/rgiordan/paragami/branch/master/graph/badge.svg)](https://codecov.io/gh/rgiordan/paragami)

## Description.

Parameter folding and flattening, parameter origami: paragami*!

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:

Covariances, Robustness, and Variational Bayes Ryan Giordano, Tamara Broderick, Michael I. Jordan <https://arxiv.org/abs/1709.02536>

A Swiss Army Infinitesimal Jackknife Ryan Giordano, Will Stephenson, Runjing Liu, Michael I. Jordan, Tamara Broderick <https://arxiv.org/abs/1806.00550>

Evaluating Sensitivity to the Stick Breaking Prior in Bayesian Nonparametrics Runjing Liu, Ryan Giordano, Michael I. Jordan, Tamara Broderick <https://arxiv.org/abs/1810.06587>

## 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.

### Installation.

To install the latest tagged version, install with pip:

python3 -m pip install paragami.

The paragami package is under rapid development, so you may want to clone the respository and use the master branch instead.

Note: In order to use the functions in sparse_preconditioners_lib, you must additionally manually install [scikit-sparse](https://github.com/scikit-sparse/scikit-sparse/), which requires the C++ libraries in libsuitesparse-dev. Most users will not require this functionality so scikit-sparse is not installed by default with paragami for simplicity. See the [scikit-sparse requirements](https://scikit-sparse.readthedocs.io/en/latest/overview.html#requirements) for more details on installation.

### Documentation and Examples.

For examples and API documentation, see [readthedocs](https://paragami.readthedocs.io/).

Alternatively, check out the repo and run make html in docs/.

* Thanks to Stéfan van der Walt for the suggesting the package name.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paragami-0.42.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

paragami-0.42-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file paragami-0.42.tar.gz.

File metadata

  • Download URL: paragami-0.42.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for paragami-0.42.tar.gz
Algorithm Hash digest
SHA256 f540373c3c2490733dba55dac22fc2bfb9ba42188199bcac61525534bb516515
MD5 b46a048dcdebdd7f0257651141bda4a5
BLAKE2b-256 0bc9445a5e35dbfff48a73163580c6e60df36ce2d657bfb2a8b3b284230cc790

See more details on using hashes here.

File details

Details for the file paragami-0.42-py3-none-any.whl.

File metadata

  • Download URL: paragami-0.42-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for paragami-0.42-py3-none-any.whl
Algorithm Hash digest
SHA256 317c72f0d23172038dc30408a45a35669e8f35e51ca10398d008d495c715e682
MD5 e443b21a84eecbbd1a1fd4fb59270949
BLAKE2b-256 d8c37aa6384643364bf48cac9e1744d321b57dbadc09d1afdfafc19e047b3845

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page