Development

The metalearners repository can be cloned as follows:

git clone https://github.com/Quantco/metalearners.git

The dependencies are managed via pixi. Please make sure to install pixi on your system. Once pixi is installed, you can install and run the pre-commit hooks as follows:

pixi run pre-commit-install
pixi run pre-commit-run

You can run the tests as follows:

pixi run postinstall
pixi run pytest tests

You can preview the documentation locally by running:

pixi run -e docs postinstall
pixi run -e docs docs

Mkdocs will start a local server and you can preview the documentation by visiting http://localhost:8000.

You can find all pixi tasks in the pixi.toml file.