Skip to main content

Exploring and eliciting probability distributions.

Project description

Exploring and eliciting probability distributions

PyPi version Build Status codecov Ruff DOI

Overview

Prior elicitation refers to the process of transforming the knowledge of a particular domain into well-defined probability distributions. Specifying useful priors is a central aspect of Bayesian statistics. PreliZ is a Python package aimed at helping practitioners choose prior distributions by offering a set of tools for the various facets of prior elicitation. It covers a range of methods, from unidimensional prior elicitation on the parameter space to predictive elicitation on the observed space. The goal is to be compatible with probabilistic programming languages (PPL) in the Python ecosystem like PyMC and PyStan, while remaining agnostic of any specific PPL.

A good companion for PreliZ is PriorDB, a database of prior distributions for Bayesian analysis. It is a community-driven project that aims to provide a comprehensive collection of prior distributions for a wide range of models and applications.

The Zen of PreliZ

  • Being open source, community-driven, diverse and inclusive.
  • Avoid fully-automated solutions, keep the human in the loop.
  • Separate tasks between humans and computers, so users can retain control of important decisions while numerically demanding, error-prone or tedious tasks are automatized.
  • Prevent users to become overconfident in their own opinions.
  • Easily integrate with other tools.
  • Allow predictive elicitation.
  • Having a simple and intuitive interface suitable for non-specialists in order to minimize cognitive biases and heuristics.
  • Switching between different types of visualization such as kernel density estimates plots, quantile dotplots, histograms, etc.
  • Being agnostic of the underlying probabilistic programming language.
  • Being modular.

Documentation

The PreliZ documentation can be found in the official docs.

Installation

Last release

PreliZ is available for installation from PyPI. The latest version (base set of dependencies) can be installed using pip:

pip install preliz

To make use of the interactive features, you can install the optional dependencies:

  • For JupyterLab:
pip install "preliz[full,lab]"
  • For Jupyter Notebook:
pip install "preliz[full,notebook]"

PreliZ is also available through conda-forge.

conda install -c conda-forge preliz

Development

The latest development version can be installed from the main branch using pip:

pip install git+git://github.com/arviz-devs/preliz.git

Citation

If you find PreliZ useful in your work, we kindly request that you cite the following paper:

@article{Icazatti_2023,
author = {Icazatti, Alejandro and Abril-Pla, Oriol and Klami, Arto and Martin, Osvaldo A},
doi = {10.21105/joss.05499},
journal = {Journal of Open Source Software},
month = sep,
number = {89},
pages = {5499},
title = {{PreliZ: A tool-box for prior elicitation}},
url = {https://joss.theoj.org/papers/10.21105/joss.05499},
volume = {8},
year = {2023}
}

Contributions

PreliZ is a community project and welcomes contributions. Additional information can be found in the Contributing Readme

Code of Conduct

PreliZ wishes to maintain a positive community. Additional details can be found in the Code of Conduct

Donations

PreliZ, as other ArviZ-devs projects, is a non-profit project under the NumFOCUS umbrella. If you want to support PreliZ financially, you can donate here.

Sponsors

NumFOCUS

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

preliz-0.24.0.tar.gz (449.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

preliz-0.24.0-py3-none-any.whl (513.9 kB view details)

Uploaded Python 3

File details

Details for the file preliz-0.24.0.tar.gz.

File metadata

  • Download URL: preliz-0.24.0.tar.gz
  • Upload date:
  • Size: 449.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for preliz-0.24.0.tar.gz
Algorithm Hash digest
SHA256 2fa511b9dc534694c9765c489b57cf28f60ee2f5fdf081e098bd70a9efc30bde
MD5 424c691c818735a1fb04e1a421f92ce4
BLAKE2b-256 2005009af2016ca9fd91fc5fa92b5761f728b7b8954f9e4007d05d07b33638ce

See more details on using hashes here.

File details

Details for the file preliz-0.24.0-py3-none-any.whl.

File metadata

  • Download URL: preliz-0.24.0-py3-none-any.whl
  • Upload date:
  • Size: 513.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for preliz-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd8f2769d113418311fd80a68c8a0b9f06ec3f159b7c15dc9dbf5deb79514dbe
MD5 b1d487f43e2013c51856495eaa58f20e
BLAKE2b-256 fc4d367b1caa4fbc2e10c8b30c0f4f77889ef9446233ca3a31ade1352645bed0

See more details on using hashes here.

Supported by

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