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.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2078dd02003abf756addd254cc92d4b4b2e52f3c3e493e221c4ed273f52ce463 |
|
MD5 | 653dbc831c58d5174e7ed3bf53848f75 |
|
BLAKE2b-256 | bc08991614ab838b317e8a20a5c1ac3243a55d92df12c5b892f5c6697e38144c |