Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for substratools, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size substratools-0.7.0-py3-none-any.whl (18.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size substratools-0.7.0.tar.gz (12.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page