Skip to main content

A helper package to conduct multiverse analyses in Python

Project description

multiversum

PyPI Tests Changelog License

multiversum is a package designed to make it easy to conduct multiverse analyses in Python. The package is intended to seemlessly integrate into a normal analysis or ML workflow and can also be added to an existing pipeline.

Installation

Install this library using pip:

pip install multiversum

Usage

The package always works with two different files: The multiversum.toml ✨️, specifying the different dimensions (and their options) and the universe.ipynb ⭐️ containing the actual analysis code. The universe file is then evaluated (in parallel) using different dimension-combinations.

An example using a machine learning workflow in scikit-learn can be found here.

Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

cd multiversum
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

python -m pip install -e '.[test]'

To run the tests:

python -m pytest

Formatting

Ruff is used for formatting and linting. Formatting can be automatically checked / applied wherever possible via ruff check . --fix && ruff format.

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

multiversum-0.1.0.tar.gz (16.6 kB view hashes)

Uploaded Source

Built Distribution

multiversum-0.1.0-py3-none-any.whl (16.4 kB view hashes)

Uploaded Python 3

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