OpenKS FL 是一个联邦学习框架，用于在多个节点之间安全地共享和训练模型，同时保护数据隐私。本说明主要涉及OpenKS FL的接口使用，这些接口涵盖了从创建训练任务、发送任务、监控任务状态到下载最终模型参数等关键操作。以下是各接口的详细说明：
1. **训练任务生成接口**：
- **HTTP 接口**: `POST /_api/fl/train_job/create`
- **功能**: 此接口用于上传模型并生成联邦学习的训练任务。
- **参数**: `model_type`，指定模型类型，支持torch或paddle，默认为torch。
- **Body**: 提供模型文件的二进制数据。
- **返回**: 包含`job_id`的JSON对象，标识生成的训练任务。
2. **训练任务发送接口**：
- **HTTP 接口**: `POST /_api/fl/train_job/send`
- **功能**: 发送训练任务到参与训练的节点。
- **参数**: 无。
- **Body**: 包含`job_id`和多个目标节点信息（地址、元数据ID地址和数据转换地址）的JSON对象。
- **返回**: 成功信息，无具体返回数据。
3. **训练任务批量查询接口**：
- **HTTP 接口**: `GET /_api/fl/train_job/list/send`
- **功能**: 批量查看已发送或接收的训练任务。
- **参数**: `cond`，可选值为'send'或'receive'，用于指定查询条件。
- **返回**: 包含多个训练任务对象的JSON数组。
4. **训练任务启动接口**：
- **HTTP 接口**: `POST /_api/fl/train_job/start`
- **功能**: 启动一个已创建的训练任务。
- **参数**: `id`，训练任务ID。
- **Body**: 包含配置信息的JSON对象。
- **返回**: 成功信息，包含配置数据的JSON对象。
5. **训练任务状态查看接口**：
- **HTTP 接口**: `GET /_api/fl/train_job/status/{job_id}`
- **功能**: 获取训练任务的进度和状态信息。
- **参数**: `job_id`，训练任务ID。
- **返回**: 包含训练任务状态信息的JSON对象。
6. **最终模型参数下载接口**：
- **HTTP 接口**: `GET /_api/fl/final_parameters/{job_id}`
- **功能**: 在训练任务完成后下载最终的模型参数。
- **参数**: `job_id`，训练任务ID。
- **返回**: 包含模型参数的ByteData。
7. **数据集接口**：
- **数据集元数据上传接口**：
- **HTTP 接口**: `POST /_api/fl/metadata/public`
- **功能**: 上传数据集元数据并在网络中公开。
- **Body**: 包含元数据和数据加载器的Base64编码的JSON对象。
- **返回**: 包含元数据地址的JSON对象。
- **数据集元数据批量获取接口**：
- **HTTP 接口**: `GET /_api/fl/metadata/list`
- **功能**: 批量获取网络中可用的数据集元数据。
- **参数**: 无。
- **返回**: 包含多个元数据对象的JSON数组。
这些接口是OpenKS FL联邦学习平台的核心组成部分，它们允许用户有效地管理和执行分布式模型训练任务，同时也提供了对数据集元数据的管理。通过这些接口，开发者可以构建起一个高效、安全的联邦学习环境，实现模型的协同训练和优化。
评论0