Python tools to submit functions on the Substra platform
Project description
Substra-tools
Substra is an open source federated learning (FL) software. This specific repository, substra-tools, is a Python package defining base classes for Dataset (data opener script) and wrappers to execute functions submitted on the platform.
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 substratools
Pull the substra-tools Docker image
docker pull ghcr.io/substra/substra-tools:0.16.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.11
Developers
Clone the repository: https://github.com/Substra/substra-tools
Build the Docker image from source
docker build -f Dockerfile .
Setup
To setup the project in development mode, run:
pip install -e ".[dev]"
To run all tests, use the following command:
make test
How to generate the changelog
The changelog is managed with towncrier.
To add a new entry in the changelog, add a file in the changes folder. The file name should have the following structure:
<unique_id>.<change_type>.
The unique_id is a unique identifier, we currently use the PR number.
The change_type can be of the following types: added, changed, removed, fixed.
To generate the changelog (for example during a release), use the following command (you must have the dev dependencies installed):
towncrier build --version=<x.y.z>
You can use the --draft option to see what would be generated without actually writing to the changelog (and without removing the fragments).
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.21.4rc1.tar.gz.
File metadata
- Download URL: substratools-0.21.4rc1.tar.gz
- Upload date:
- Size: 26.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ed3545130da3d69a6d697da6ad79fff1d102dcd355bf72d2853f89ac3c9bf3d |
|
| MD5 | 9553c66d6f226b7e3c8881d3f7b02140 |
|
| BLAKE2b-256 | a1053fcbdb1d21999735bfbe047c9afd2783947a34bd8342662b71dc4e8d436a |
Provenance
File details
Details for the file substratools-0.21.4rc1-py3-none-any.whl.
File metadata
- Download URL: substratools-0.21.4rc1-py3-none-any.whl
- Upload date:
- Size: 19.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3802412c85e3c74d3e2d1b8fed4ee5423e4233f2e17cb7d0e39b91f5b188c4c2 |
|
| MD5 | 421986a28c95f07f55f36aeebb8be197 |
|
| BLAKE2b-256 | 10f8e988f22ec153ad904c4463dc53a9c920766047f0c9689e8569076715e10b |
