Merge pull request #5 from DanielLi529/main

新增组件：
secretflow · Jul 3, 2024 · f60c246 · f60c246
2 parents 1d78fc6 + 56ef74f
commit f60c246
Show file tree

Hide file tree

Showing 17 changed files with 165 additions and 90 deletions.
diff --git a/README.md b/README.md
@@ -1,30 +1,12 @@
-<div align="center">
-    <img src="https://raw.githubusercontent.com/secretflow/secretflow/5fc83d0b82563c49a5be71ce6cd3b0435ad904c1/docs/_static/logo-light.png">
-</div>
-
----
-
-<p align="center">
-    <a href="./README.zh-CN.md">简体中文</a> | English
-</p>
-
-# SecretFlow Product Documentation
-
-This repository tracks source code for some of [SecretFlow](https://github.com/secretflow/secretflow) project's online documentation.
-
-**For a better reading experience, visit [www.secretflow.org.cn/docs](https://www.secretflow.org.cn/docs).**
-
-This repository currently contains documentation for the following products:
-
-- [SecretPad all-in-one](./docs/all-in-one/index.rst)
-
-For source code for individual projects, please refer to the following repositories:
-
-- [heu](https://github.com/secretflow/heu/tree/main/docs)
-- [kuscia](https://github.com/secretflow/kuscia/tree/main/docs)
-- [psi](https://github.com/secretflow/psi/tree/main/docs)
-- [scql](https://github.com/secretflow/scql/tree/main/docs)
-- [secretflow](https://github.com/secretflow/secretflow/tree/main/docs)
-- [secretpad](https://github.com/secretflow/secretpad/tree/main/docs)
-- [spu](https://github.com/secretflow/spu/tree/main/docs)
-- [trustedflow](https://github.com/secretflow/trustedflow/tree/main/docs)
+# 隐语产品文档
+## 简介
+欢迎访问隐语产品文档的GitHub仓库！这个仓库包含了 SecretPad all in one 的文档。通过本仓库，您可以获取到 SecretPad all in one 的安装部署、使用说明等内容。
+## 目录结构
+* 什么是SecretPad all in one：介绍什么是 all in one 包和隐语平台。
+* P2P部署模式：提供中心化架构下的部署指南、使用指南等。
+* 中心化部署模式：提供中心化架构下的部署指南、使用指南等。
+* 平台组件说明：详细介绍平台各个组件的功能、作用、使用方法等。
+* 更多教程：隐语SecretPad平台新增组件，提供自定义组件教程。
+* 相关名词解释：对本文档中出现的专业术语和名词进行定义和解释。
+* 版本更新：记录更新历史和新增功能。
+
diff --git a/docs/all-in-one/center_deploy/index.rst b/docs/all-in-one/center_deploy/index.rst
@@ -5,7 +5,7 @@
 .. toctree::
     :maxdepth: 2
 
-    platform_installation_guidelines_center
+    platform_installation_guidelines
     node_installation_guidelines
     cooperation_node
     method1

diff --git a/docs/all-in-one/components_instruction.md b/docs/all-in-one/components_instruction.md
diff --git a/docs/all-in-one/imgs/data10.png b/docs/all-in-one/imgs/data10.png
diff --git a/docs/all-in-one/imgs/data11.png b/docs/all-in-one/imgs/data11.png
diff --git a/docs/all-in-one/imgs/data12.png b/docs/all-in-one/imgs/data12.png
diff --git a/docs/all-in-one/imgs/data_source1.png b/docs/all-in-one/imgs/data_source1.png
diff --git a/docs/all-in-one/imgs/group_stability.png b/docs/all-in-one/imgs/group_stability.png
diff --git a/docs/all-in-one/imgs/sampling.png b/docs/all-in-one/imgs/sampling.png
diff --git a/docs/all-in-one/imgs/scoring.png b/docs/all-in-one/imgs/scoring.png
diff --git a/docs/all-in-one/imgs/type_conversion.png b/docs/all-in-one/imgs/type_conversion.png
diff --git a/docs/all-in-one/more_tutorials/new_components.md b/docs/all-in-one/more_tutorials/new_components.md
@@ -338,7 +338,7 @@ def ss_compare_eval_fn(
     )
 
     # only local fs is supported at this moment.
-    data_dir = ctx.data_dir
+    local_fs_wd = ctx.local_fs_wd
 
     # get spu config from ctx
     if ctx.spu_configs is None or len(ctx.spu_configs) == 0:

diff --git a/docs/all-in-one/p2p_deploy/function_description/data.md b/docs/all-in-one/p2p_deploy/function_description/data.md
@@ -6,31 +6,23 @@
 
 ## 2. 添加数据
 
-### 2.1.添加本地数据
+用户需添加自有数据用于离线任务研发或在线预测，在数据管理右侧点击“添加数据”：
 
-用户需添加自有数据用于计算训练，数据管理—点击“添加数据”按钮—上传或拖拽本地文件至右侧区域
+![Data1](../../imgs/data10.png)
 
-![Data1](../../imgs/data1.png)
+可选择本地数据源、HTTP数据源或在数据源管理注册的oss数据源；
 
-<font color=#DF2A3F> 注：需在此页面等待数据上传完毕，如中途关闭页面会导致数据上传中断 </font>
+以选择本地数据源为例：
 
-![Data2](../../imgs/data2.png)
+<font color=#DF2A3F>注：需在此页面等待数据上传完毕，如中途关闭页面会导致数据上传中断</font>
 
-设置数据表名称—输入数据表描述及特征描述—点击“提交”。
+![Data2](../../imgs/data11.png)
 
-<font color=#DF2A3F> 重要：特征名称需和实际文件的schame名称保持一致。</font>
+上传数据后，可设置数据表名称、输入数据表描述及特征描述后点击“提交”。
 
-![Data3](../../imgs/data3.png)
+<font color=#DF2A3F>重要：特征名称需和实际文件的schame名称保持一致。</font>
 
-### 2.2.添加HTTP数据
-
-当需要进行模型发布时，用户需添加SPI，即HTTP数据并授权进项目。
-![Data8](../imgs/../../imgs/data8.png)
-
-设置数据表名称—输入数据表描述及特征描述—填写数据表结构后，点击“提交”。
-
-<font color=#DF2A3F> 重要：特征名称需和实际文件的schame名称保持一致。</font>
-![Data9](../imgs/../../imgs/data9.png)
+![Data3](../../imgs/data12.png)
 
 ## 3. 删除数据
 

diff --git a/docs/all-in-one/p2p_deploy/function_description/data_source.md b/docs/all-in-one/p2p_deploy/function_description/data_source.md
@@ -0,0 +1,19 @@
+# 数据源管理
+
+## 1. 模块说明
+
+本模块主要是对节点自有数据源进行管理，包括数据源增删改查，当前仅支持OSS数据源；本地文件和HTTTP数据在数据管理添加数据即可
+
+## 2. 注册数据源
+在数据源管理页面，点击注册数据：
+![Data1](../../imgs/data_source1.png)
+### 需输入
+- 平台展示的名字，即显示名称 
+- endpoint名称
+- AcessKeyID
+- AcessKeySecret
+- virtualhost 
+  - 阿里云的oss需要打开这个virtualhost；其余minio等不需要
+- bucket
+- 预设路径（可选）
+- 节点连接配置
diff --git a/docs/all-in-one/version_update/202307.md b/docs/all-in-one/version_update/202307.md
@@ -2,7 +2,7 @@
 
 **更新时间：** 2023年7月5日
 
-**更新内容：**
+**更新内容：**  
 
 隐语开放平台已在过去一年内面向 50+ 机构开放体验。此次，隐语 1.0 版本带来全新的 **MVP（Minimum Viable
 Product）部署体验包：一款面向隐私计算初学用户的轻量级功能体验工具，内置节点、数据资源，节点间已相互授权，安装即可体验数据处理、数据分析、模型开发、模型评估等主要常见功能
@@ -18,7 +18,7 @@ Product）部署体验包：一款面向隐私计算初学用户的轻量级功
 
 ## <font color=#3088F2> 2.隐语 MVP 部署体验包的具体优势 </font>
 
-- 优势一：化繁为简 减少准备步骤中的卡点
+- 优势一：化繁为简 减少准备步骤中的卡点  
 
 在原本的体验流程中，用户需要自行配置节点资源和数据资源。为了解决准备链路长、卡点多的问题，隐语 MVP
 部署体验包将这些准备步骤封装在包内，并以“一键安装包”的形式提供给用户。其安装过程也涵盖了联合项目的前序准备，因此用户可以更快速地开始体验隐私计算功能。

diff --git a/docs/all-in-one/version_update/202404.md b/docs/all-in-one/version_update/202404.md
@@ -5,7 +5,7 @@
 **新功能：**
 
 1. 完善P2P模式下平台引擎日志，日志模块支持阿里云SLS
-2. 支持SecretPad元数据mysql存储，并提供MySQL 数据库的支持文档
+2. 支持MySQL数据源，并提供MySQL 数据库的支持文档
 
 **功能更新：**
 

diff --git a/docs/all-in-one/version_update/202406.md b/docs/all-in-one/version_update/202406.md
@@ -0,0 +1,13 @@
+# 2024年6月更新记录
+
+**更新时间： 2024年07月02日**
+**更新内容：**
+**新功能：**
+
+1. 新增类型转换、采样、评分卡转换、人群稳定性评估组件；
+2. 新增数据源管理，支持增删改查；并新增支持OSS数据源；
+3. 支持画布粒度配置默认存储数据源；
+
+**功能更新：**
+
+1. Easy PSI漏洞修复；