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.
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
File details
Details for the file substratools-0.5.0.tar.gz.
File metadata
- Download URL: substratools-0.5.0.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 97d1bdcb26226c7756fccd11224334f56fee4b548d4c4e246beb318e8bade7c0 |
|
| MD5 | 3a70de0d827f29b505cfdee86132f87b |
|
| BLAKE2b-256 | b256e86479e4dde82ae4c14e10c5b90ec422349a5a818043ebd73496125de3f0 |
Provenance
File details
Details for the file substratools-0.5.0-py3-none-any.whl.
File metadata
- Download URL: substratools-0.5.0-py3-none-any.whl
- Upload date:
- Size: 16.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 068dc2524654d3a653724ea7cb81909287941a72b135aa0481e6da4c221eae92 |
|
| MD5 | d928e71fccf8b995b0d97cd945c6d534 |
|
| BLAKE2b-256 | 1b5220a430c94967b711c1850c8421014bcd1701f3bd4107450cc968a9efb10a |
