Readme

My personal little ML engineering library.

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

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

• Free software: MIT

Features

• Multivariate performance testing - with plots!

• An extensible ID translation suite, including SQL integration for retrival of data

• Various other utilities methods - from logging configuration to fetching data from the web

• Two-directional mapping implementation in rics.mapping

Quickstart for development

Notice

This project uses groups for extras dependencies, which is currently a PRERELEASE feature (slated for 1.2). Assuming poetry was installed the recommended way (see below), this can be done using:

curl -sSL https://install.python-poetry.org/ | python -
poetry self update --preview 1.2.0a2

Setting up for local development

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

This project uses groups for extras dependencies. If installation fails, make sure that output from poetry --version is 1.2.0 or greater.

To get started, run the following commands:

1. Installing the latest version of Poetry

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

2. Installing the project

   git clone git@github.com:rsundqvist/rics.git
   cd rics
   poetry install --with dev-extras
   inv install-hooks
   ./run-invocations
   

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

Registering the project on Codecov

Probably only for forking?

curl -Os https://uploader.codecov.io/latest/linux/codecov
chmod +x codecov

Visit https://app.codecov.io and log in, follow instructions to link the repo and get a token for private repos.

CODECOV_TOKEN="<from-the-website>"
inv coverage --fmt=xml
./codecov -t ${CODECOV_TOKEN}

Credits

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