Aeromancy project template

This is a Copier template for getting a new Aeromancy-managed project up and running quickly. If you're not familiar with Aeromancy, you'll want to start with its documentation. This template (along with Aeromancy) is fairly opinionated makes a lot of decisions for you in terms of workflows.

The template will build stubs for all necessary Aeromancy components. The initial setup creates a simple ML pipeline with three steps:

1. Load a dataset
2. Train a model on the dataset
3. Evaluate the model on the dataset

Requirements

This template requires the following dependencies:

• Python (3.10+)
• Git

Quick Start

1. Install PDM with Copier support:

pip install --user "pdm[copier]"

2. Set up a new Aeromancy-managed project with this template: (this will create the project directory for you)

copier copy --trust "gh:quant-aq/aeromancy-project-template" <project_name>

3. Install project dependencies:

cd <project_name>
git init ; pdm install --dev --no-self

4. Check out Aeromancy docs for more information!

Template features

The template was originally based on pdm-project/copier-pdm with some modifications in dmcc/copier-pdm.

Package manager

The template project uses PDM, with a pre-defined pyproject.toml.

Documentation and changelog

• Documentation is built with MkDocs (Material theme)

Pre-commit and linter

pre-commit is used for both commit hook and linting, including the following hooks:

• ruff (linting and formatting in Black style)
• keep-sorted
• do-not-submit

Tests

• Tests run with pytest. GitHub Actions provide matrix support.