Skip to main content

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

Release files for paragami 0.42

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paragami 0.42
File Size Uploaded
paragami-0.42.tar.gz 56.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for paragami 0.42
File Interpreter ABI Platform
paragami-0.42-py3-none-any.whl Python 3 none any Details

Total release size:98.0 kB

Release files / paragami-0.42.tar.gz

Download URL paragami-0.42.tar.gz
Size 56.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f540373c3c2490733dba55dac22fc2bfb9ba42188199bcac61525534bb516515
BLAKE2b-256 checksum
How to use checksums
0bc9445a5e35dbfff48a73163580c6e60df36ce2d657bfb2a8b3b284230cc790
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / paragami-0.42-py3-none-any.whl

Download URL paragami-0.42-py3-none-any.whl
Size 41.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
317c72f0d23172038dc30408a45a35669e8f35e51ca10398d008d495c715e682
BLAKE2b-256 checksum
How to use checksums
d8c37aa6384643364bf48cac9e1744d321b57dbadc09d1afdfafc19e047b3845
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.42 This release

2 release files

0.34

2 release files

0.33

2 release files

0.32

1 release file

0.31

2 release files

0.4

2 release files

0.3

2 release files

0.2

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page