An experiment workflow and organization tool
Project description
Curifactory
Curifactory is a library and CLI tool designed to help organize and manage research experiments in python.
Experiment management must fulfill several tasks, including experiment orchestration, parameterization, caching, reproducibility, reporting, and parallelization. Existing projects such as MLFlow, MetaFlow, Luigi, and Pachyderm support these tasks in several different ways and to various degrees. Curifactory provides a different opinion, with a heavier focus on supporting general research experiment workflows for individuals or small teams working primarily in python.
You can read more about these design principles in our paper in the SciPy 2022 proceedings.
Features
- Adds a CLI layer on top of your codebase, a single entrypoint for running experiments
- Automatic caching of intermediate data and lazy loading of stored objects
- Jupyter notebook output for further exploration of an experiment run
- Docker container output with copy of codebase, conda environment, full experiment run cache, and jupyter run notebook
- HTML report output from each run with graphviz-rendered diagram of experiment
- Easily report plots and values to HTML report
- Configuration files are python scripts, allowing programmatic definition, parameter composition, and parameter inheritance
- Output logs from every run
- Run experiments directly from CLI or other python code, notebooks, etc.
Installation
pip install curifactory
Graphviz is required for certain features and can be installed through conda via:
conda install python-graphviz
Documentation
The documentation for the latest version of Curifactory can be found at: https://ornl.github.io/curifactory/latest/index.html.
Examples
Several small example projects can be found in the examples
folder.
examples/notebook-based
includes notebooks demonstrating usage of curifactory
solely in Jupyter. examples/minimal
shows a basic single-file experiment
script.
Citation
Please see the following DOI if citing this project: 10.11578/dc.20220208.1
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for curifactory-0.9.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7305d26e5dd1aa9f8f11556dc3364e2972248811ce0a153452926042c5445771 |
|
MD5 | 828715e6a8c54a7344953bb8de2c609f |
|
BLAKE2b-256 | 6b1b28c261d0d35c9890c049535eab4cb5388f435f811fec83b172bbf98c19f7 |