Readme

My personal little ML engineering library.

• GitHub repo: https://github.com/rsundqvist/rics.git

• Documentation: https://rics.readthedocs.io

• Free software: MIT

Setting up for local development

Assumes a “modern” version of Ubuntu (guide written under Ubuntu 20.04.2 LTS) with basic dev dependencies installed.

To get started, run the following commands:

1. Installing Poetry and Invoke

   curl -sSL https://install.python-poetry.org/ | python -
   pip install invoke
   

2. Installing the project

   git clone git@github.com:rsundqvist/rics.git
   cd rics
   poetry install -E translation -E plotting
   inv install-hooks
   ./run-invocations.sh
   

   The last step is optional, but serves to verify that the project is ready-to-run.

Credits

This package was created with Cookiecutter and the fedejaure/cookiecutter-modern-pypackage project template.