README.md

Python Client Library for ML Aide

Run example scripts

In examples/ you can find some python scripts as an example. The shell scripts can be used for easier usage.

Run the following commands once in a terminal session

cs/
source ./set_api_key.sh

After that you can use the following command to run the scripts over and over again:

./run_example.sh

Contribution

Prerequisites

1. Install Python
2. Install Python Poetry
3. Optional - Install IDE: PyCharm or Visual Studio Code

Setup Environment

1. Install environment and download dependencies

   poetry install

2. Activate environment

   poetry shell

Run Tests

# run tests once
pytest

# run tests in watch mode
ptw

# run tests and scan code coverage
coverage run --branch --source mlaide -m pytest
coverage html

Build

poetry build

Publish (on PyPI)

poetry publish

Links

• Homepage: https://mlaide.com
• Quickstart: https://docs.mlaide.com/start/quickstart/
• Tutorial: https://docs.mlaide.com/tutorial/introduction/
• Documentation: https://docs.mlaide.com/