Epochalyst is the base for Team Epoch competitions.

This package contains many modules and classes necessary to construct the src code for machine learning competitions.

Epochalyst: A fusion of "Epoch" and "Catalyst," this name positions your pipeline as a catalyst in the field of machine learning, sparking significant advancements and transformations.

Install epochalyst using Rye:

rye add epochalyst

Or via pip:

pip install epochalyst

Depending on what data libraries you use, you can install the following optional dependencies:

rye add epochalyst[numpy,pandas,dask,polars]  # Pick one or more of these

Depending on what type of competition you are participating in, you can install the following optional dependencies:

rye add epochalyst[image,audio]  # Pick one or more of these

Aside from that, you can install the following optional dependencies:

rye add epochalyst[onnx,openvino]  # Optimizing model inference

To generate pytest coverage report run

rye run pytest --cov=epochalyst --cov-branch --cov-report=html:coverage_re

This repository uses pre-commit with Ruff and MyPy hooks for code quality checks and auto-formatting. To install the pre-commit hooks, run:

rye run pre-commit install

To run the pre-commit checks on all files, run:

rye run pre-commit run --all-files

Documentation is generated using Sphinx and can be found here.

To make the documentation yourself, run make html with docs as the working directory. The documentation can then be found in docs/_build/html/index.html.

Epochalyst was created by Team Epoch IV, based in the Dream Hall of the Delft University of Technology.