Substra: Python Federated Learning Library

Substra

Substra is open-source federated-learning software for training and validating machine-learning models across distributed datasets; this repository contains the low-level Python library for interacting with a Substra network.

Independent OpenViST project profile, based on linked sources.

Understand the project

Practical overview

When it fits

Use Substra when model training or validation needs to operate across distributed datasets, or when you want a local federated-learning simulation for debugging before working with a network.

Who it is for

Python developers building workflows for federated model training or validation.
Machine-learning teams needing to work with distributed datasets.
Developers who want to simulate federated learning on one machine while debugging.

Documented uses

Build Python workflows that interact with a Substra network.
Train and validate models across distributed datasets.
Run single-machine federated-learning simulations to debug code.

Before you choose

Requirements & limits

The repository is public, open source, and licensed under Apache-2.0.

The repository is the low-level Python library for interacting with a Substra network, while the project also describes a web application for running training at scale.
A single-machine simulation is supported for debugging; the project's stated main usage is production environments.
The README links to an MNIST example using the PyTorch interface.
Some repository tests require Docker.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Set up the Substra project in development mode

Install the project’s development dependencies in editable mode.

Before you start

A Python environment with pip.
The Substra repository checked out locally.

Steps

From the repository directory, run the command below.
Documented command
```
pip install -e ".[dev]"
```
Optionally, run the command below to run the test suite.
Documented command
```
make test
```

Expected outcome

The project is installed in development mode with its development dependencies; running the optional command starts the project’s test suite.

Guide limitations

Some tests require Docker to be running.
This setup procedure does not describe how to connect to a Substra network or run a federated-learning workflow.

Documentation 1 ↗

Evidence and transparency

Sources & review

Official repository ↗

Source record details

Source availability: Active
Sources checked: 12 October 2026
Original website title: Substra/substra · Official homepage title · retained in its source language

How we review sources Suggest a correction