substrafoundation/substra-tools

Substra-tools镜像说明

镜像概述

Substra-tools镜像是Substra平台的配套工具镜像，包含定义平台资产（Objective、Algo、Dataset）的Python基础类，以及执行用户Python脚本的Docker环境。该镜像可直接使用substratools包，无需依赖外部PyPI服务器，适用于Substra平台的开发与测试场景。

核心功能

1. 提供平台资产基础类：包含Objective（指标脚本）、Algo（算法脚本）、Dataset（数据打开脚本）的Python基类，支持用户快速开发平台资产。
2. 执行环境支持：作为Substra平台的运行环境，可直接执行用户提交的Python脚本。
3. 镜像获取灵活：支持从公共Docker registry拉取，或从源码构建自定义镜像。

使用场景

1. Substra平台资产开发：用于开发并提交算法、目标、数据集等平台资产。
2. Substra框架本地开发：作为Substra框架的本地开发环境，支持功能测试与调试。

配置说明

安装substratools包

若需本地使用substratools Python包，执行以下命令：

sh
pip install .

获取镜像

从公共Registry拉取

sh
docker pull substrafoundation/substra-tools

从源码构建

sh
docker build -t substrafoundation/substra-tools .

开发环境设置

若需以开发模式设置项目，执行：

sh
pip install -e .[test]

运行测试

执行所有测试用例：

sh
python setup.py test

生成文档

生成Python SDK文档：

sh
pydocmd simple substratools.Algo+ substratools.Metrics+ substratools.Opener+> docs/api.md

文档将生成在docs/目录下。