CONTRIBUTING.md

Contributor Guide

Get started

Clone the repository (e.g. using GitHub desktop, or the gh command line tool) and install it in "editable" mode in an isolated python environment, (e.g. with virtualenv) as follows:

In the repository root, create a new virtual environment:

virtualenv venv

Activate it:

source venv/bin/activate

Use pip install to install the current project (".") in editable mode (-e) with dev-dependencies ([dev]):

pip install -e ".[dev]"

Run the test cases:

pytest --doctest-modules

Activate the pre-commit hooks:

pre-commit install

Add a new dataset

New datasets should match existing examples in src/autora/experiment_runner/synthetic/.

💡A good starting point might be to duplicate an existing example.

Each experiment is described in a single file which includes a "factory function" which:

• constructs the experiment, and
• optionally takes parameters to tune aspects of the experiment.

New experiments fulfilling these requirements can be submitted as pull requests.

Publish the package

This package is published using GitHub actions – create a new "Release" on the GitHub repository, and Actions will do the rest.