Python tools to submit algo on the Substra platform
Project description
Substra-tools
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.
Getting started
To install the substratools python package, run the following command:
pip install .
Documentation
Build substra-tools image
This is required to launch the substra framework for development. The image is currently based on Python 3.6.
Pull from public docker registry
docker pull substrafoundation/substra-tools
Build from source
docker build -t substrafoundation/substra-tools .
Contributing
Setup
To setup the project in development mode, run:
pip install -e .[test]
To run all tests, use the following command:
python setup.py test
Documentation
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for substratools-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95e8bf73595a1f5a0a7f1020e39011e698bc1c26d50d5735a666cb3749124a67 |
|
MD5 | 9f4c8ed00368da6fca675aae88ae2f9c |
|
BLAKE2b-256 | 8e6356e570a2ec413e6666300108e62e6f791f6f8b596f222c9a1b434d502a5b |