README.md

HYPEX

A Framework for Hyperparameter Optimization in Time Series Anomaly Detection

Development Setup

You need the following:

• Python 3.8 or Python 3.9

Then you can execute:

git clone [email protected]:HPI-Information-Systems/hypex.git
cd hypex
make setup

This creates the dev environment in .venv, installs all dependencies, and HYPEX in development (editable) mode.

Update Dependencies

1. Add dependency to requirements.in, requirements-ci.in, or requirements-dev.in

2. Add dependency to setup.cfg under install_requires if its a runtime dependency

3. Pip-compile all dependencies to generate the requirements*.txt-files:

   make deps

4. To install the dependencies run make install or make install-dev.

Release a New Version

1. Make sure to update CHANGELOG.rst -> Unreleased

2. Release via

   make release version=0.1.0