Python package defining base classes for assets submitted on the platform:
- Objective: metrics script
- Algo: algo script
- Dataset: data opener script
This repository also contains a Dockerfile to execute the user python scripts on the Substra platform. This is currently needed to easily have substratools package available inside the Docker image without using a pypi server.
To install the substratools python package, run the following command:
pip install .
This is required to launch the substra framework for development. The image is currently based on Python 3.6.
docker pull substrafoundation/substra-tools
docker build -t substrafoundation/substra-tools .
To setup the project in development mode, run:
pip install -e .[test]
To run all tests, use the following command:
python setup.py test
Use the following command to generate the python sdk documentation:
pydocmd simple substratools.Algo+ substratools.Metrics+ substratools.Opener+> docs/api.md
Documentation will be available in docs/ directory.