docs: update readme (#31)

secretflow · Mar 5, 2024 · 03f13c7 · 03f13c7
1 parent fedcc2f
commit 03f13c7
Show file tree

Hide file tree

Showing 29 changed files with 906 additions and 410 deletions.
diff --git a/README.md b/README.md
@@ -1,44 +1,16 @@
 ## 介绍
 
-secretnote 是专为隐语开发者打造的高级工具套件。以 notebook 的形式呈现，支持多节点代码执行和文件管理，同时提供运行状态追踪功能，极大地提升开发者的效率和工作体验。
+SecretNote 是专为隐语开发者打造的高级工具套件。以 notebook 的形式呈现，支持多节点代码执行和文件管理，同时提供运行状态追踪功能，能较大程度提升开发者的效率和工作体验。
 
-<p align="center"><img alt="architecture" src="./docs/static/img/secretnote.jpg"></p>
+**由于系统安全等问题，SecretNote 不是为生产设计的，请不要直接在生产环境中使用。**
 
 ## 使用
 
-### 与 secretflow 一起使用
+### 与 SecretFlow 一起使用
 
-#### pip 安装方式
+SecretNote 有单独的 [pip](https://pypi.org/project/secretnote/) 安装包，可以单独使用。为了避免安装、部署、启动等环境问题，推荐使用 docker 方式启动 SecretFlow 运行环境。
 
-secretnote 提供单独的 python 包，可以通过 pip 安装。下面介绍如何在两台机器上使用 secretnote 创建 secretflow 运行环境。
-
-1. 分别在两台机器上安装 secretflow 和 secretnote。（python 环境需求：>=3.8, <3.12）
-
-```bash
-pip install -U secretflow
-pip install -U secretnote
-```
-
-2. 在任意一台机器上启动 secretnote 服务。
-
-```bash
-secretnote
-```
-
-3. 在浏览器中打开步骤 2 启动服务的 web client，默认地址为 `http://ip:8888`，并按照新手引导页面熟悉 secretnote 的基本操作。
-
-#### docker 安装方式
-
-secretnote 也提供 docker 镜像，可以通过 docker 安装。下面介绍如何在一台机器上使用 secretnote 创建两个 secretflow 运行环境。
-
-1. 启动两个容器
-
-```bash
-docker run -it -p 8090:8888 -e "SELF_PARTY=alice" secretflow/secretnote:unstable-amd64
-docker run -it -p 8092:8888 -e "SELF_PARTY=bob" secretflow/secretnote:unstable-amd64
-```
-
-也可以使用 docker compose:
+1. 启动两个容器，推荐使用 docker compose，这样方便管理容器之间的通信。
 
 ```yml
 services:
@@ -67,24 +39,26 @@ services:
       - /root/scripts
 ```
 
-2. 在浏览器中打开 http://127.0.0.1:8090，并按照新手引导页面熟悉 secretnote 的基本操作。
+```bash
+docker compose up
+```
+
+2. 在浏览器中打开 `http://localhost:8090` 或者 `http://localhost:8092` 访问 Web Client 进行 SecretFlow 代码研发。详细步骤可以参考[文档](./docs/guide/secretnote-sf.md)。
 
 ### 与 SCQL 一起使用
 
-secretnote 通过对 p2p scql 进行产品化封装，可以通过 web client 降低开发者编写 scql query 以及配置 ccl 的难度。下面介绍使用方式：
+SecretNote 通过对 P2P SCQL 进行产品化封装，可以通过 Web Client 降低开发者编写 SCQL Query 以及配置 CCL 的难度。
 
-1. 分别在两台机器上部署 scql 环境，参考 [P2P 模式部署](https://www.secretflow.org.cn/docs/scql/0.5.0b2/zh-Hans/topics/deployment/how-to-deploy-p2p-cluster)。
+1. 分别在两台机器上部署 SCQL 环境，参考 [P2P 模式部署](https://www.secretflow.org.cn/docs/scql/0.5.0b2/zh-Hans/topics/deployment/how-to-deploy-p2p-cluster)。
 
-2. 分别在两台机器上安装 secretnote，并启动服务。
+2. 分别在两台机器上安装 SecretNote，并启动服务。
 
 ```bash
 pip install -U secretnote
-```
 
-```bash
 # party 为 scql broker 服务的 party_code
 # host 为 scql broker 服务的地址
 secretnote -mode=scql --party=alice --host=http://127.0.0.1:8991
 ```
 
-3. 在浏览器中打开步骤 2 启动服务的 web client，默认地址为 `http://ip:8888`，并按照新手引导页面熟悉 secretnote 的基本操作。
+3. 分别打开两台机器的启动的 Web Client，然后在 Web Client 上完成整个 SCQL 研发流程。详细步骤可以参考[文档](./docs/guide/secretnote-scql.md)。
diff --git a/docker/sim/docker-compose.yml b/docker/sim/docker-compose.yml
@@ -6,7 +6,7 @@ services:
       - SELF_PARTY=alice
       - ALL_PARTIES=alice,bob
     ports:
-      # Jupyter
+      # SecretNote
       - 8090:8888
     entrypoint: /root/scripts/start.sh
     volumes:
@@ -19,7 +19,7 @@ services:
       - SELF_PARTY=bob
       - ALL_PARTIES=alice,bob
     ports:
-      # Jupyter
+      # SecretNote
       - 8092:8888
     entrypoint: /root/scripts/start.sh
     volumes:

diff --git a/docs/contributing/devcontainers.md b/docs/contributing/devcontainers.md
diff --git a/docs/guide/data/iris_alice.csv b/docs/guide/data/iris_alice.csv
@@ -0,0 +1,136 @@
+sepal length (cm),sepal width (cm),petal length (cm),petal width (cm),uid,month
+6.1,2.6,5.6,1.4,134,Feb
+6.0,2.9,4.5,1.5,78,Feb
+6.1,2.9,4.7,1.4,63,Jan
+5.8,2.6,4.0,1.2,92,Feb
+6.7,3.3,5.7,2.1,124,Feb
+5.6,3.0,4.1,1.3,88,Feb
+6.9,3.1,4.9,1.5,52,Jan
+7.7,3.0,6.1,2.3,135,Feb
+4.4,3.0,1.3,0.2,38,Jan
+4.8,3.0,1.4,0.3,45,Jan
+6.0,3.0,4.8,1.8,138,Feb
+5.1,3.8,1.9,0.4,44,Jan
+5.4,3.9,1.7,0.4,5,Jan
+6.9,3.1,5.4,2.1,139,Feb
+6.7,3.1,5.6,2.4,140,Feb
+4.9,2.5,4.5,1.7,106,Feb
+6.5,3.0,5.2,2.0,147,Feb
+7.7,3.8,6.7,2.2,117,Feb
+6.8,2.8,4.8,1.4,76,Feb
+6.5,2.8,4.6,1.5,54,Jan
+5.8,2.7,4.1,1.0,67,Jan
+5.5,2.4,3.7,1.0,81,Feb
+6.2,3.4,5.4,2.3,148,Feb
+4.9,3.6,1.4,0.1,37,Jan
+7.2,3.2,6.0,1.8,125,Feb
+5.7,2.8,4.1,1.3,99,Feb
+6.4,2.9,4.3,1.3,74,Jan
+6.7,3.3,5.7,2.5,144,Feb
+5.4,3.4,1.7,0.2,20,Jan
+6.9,3.1,5.1,2.3,141,Feb
+6.4,2.8,5.6,2.1,128,Feb
+5.0,3.3,1.4,0.2,49,Jan
+6.7,2.5,5.8,1.8,108,Feb
+7.6,3.0,6.6,2.1,105,Feb
+6.3,3.3,6.0,2.5,100,Feb
+5.8,2.7,3.9,1.2,82,Feb
+5.6,2.7,4.2,1.3,94,Feb
+4.9,3.1,1.5,0.2,34,Jan
+5.0,3.6,1.4,0.2,4,Jan
+5.1,3.4,1.5,0.2,39,Jan
+4.9,3.0,1.4,0.2,1,Jan
+4.4,2.9,1.4,0.2,8,Jan
+5.0,3.2,1.2,0.2,35,Jan
+5.7,3.8,1.7,0.3,18,Jan
+5.8,2.8,5.1,2.4,114,Feb
+4.6,3.4,1.4,0.3,6,Jan
+6.3,3.3,4.7,1.6,56,Jan
+7.2,3.0,5.8,1.6,129,Feb
+6.4,3.2,5.3,2.3,115,Feb
+5.1,3.8,1.5,0.3,19,Jan
+5.1,3.5,1.4,0.3,17,Jan
+6.8,3.0,5.5,2.1,112,Feb
+4.3,3.0,1.1,0.1,13,Jan
+5.6,2.9,3.6,1.3,64,Jan
+5.6,2.8,4.9,2.0,121,Feb
+6.0,2.2,5.0,1.5,119,Feb
+4.9,3.1,1.5,0.1,9,Jan
+5.0,2.0,3.5,1.0,60,Jan
+7.7,2.6,6.9,2.3,118,Feb
+6.2,2.9,4.3,1.3,97,Feb
+6.5,3.2,5.1,2.0,110,Feb
+5.0,2.3,3.3,1.0,93,Feb
+6.4,3.2,4.5,1.5,51,Jan
+4.8,3.1,1.6,0.2,30,Jan
+5.3,3.7,1.5,0.2,48,Jan
+5.5,2.6,4.4,1.2,90,Feb
+5.1,3.5,1.4,0.2,0,Jan
+6.0,2.7,5.1,1.6,83,Feb
+6.3,2.5,4.9,1.5,72,Jan
+6.1,3.0,4.9,1.8,127,Feb
+4.6,3.1,1.5,0.2,3,Jan
+5.2,3.5,1.5,0.2,27,Jan
+6.9,3.2,5.7,2.3,120,Feb
+6.4,2.7,5.3,1.9,111,Feb
+6.1,2.8,4.0,1.3,71,Jan
+4.8,3.0,1.4,0.1,12,Jan
+5.7,2.9,4.2,1.3,96,Feb
+5.1,3.3,1.7,0.5,23,Jan
+5.2,2.7,3.9,1.4,59,Jan
+5.4,3.0,4.5,1.5,84,Feb
+5.0,3.4,1.6,0.4,26,Jan
+5.1,3.8,1.6,0.2,46,Jan
+6.7,3.1,4.4,1.4,65,Jan
+6.3,2.9,5.6,1.8,103,Feb
+6.3,2.8,5.1,1.5,133,Feb
+5.0,3.0,1.6,0.2,25,Jan
+6.6,2.9,4.6,1.3,58,Jan
+5.5,2.3,4.0,1.3,53,Jan
+5.9,3.0,4.2,1.5,61,Jan
+5.5,4.2,1.4,0.2,33,Jan
+7.7,2.8,6.7,2.0,122,Feb
+6.0,2.2,4.0,1.0,62,Jan
+4.7,3.2,1.3,0.2,2,Jan
+5.8,4.0,1.2,0.2,14,Jan
+5.4,3.7,1.5,0.2,10,Jan
+5.0,3.5,1.6,0.6,43,Jan
+5.5,2.4,3.8,1.1,80,Feb
+6.1,2.8,4.7,1.2,73,Jan
+6.5,3.0,5.5,1.8,116,Feb
+4.6,3.2,1.4,0.2,47,Jan
+6.3,2.7,4.9,1.8,123,Feb
+4.8,3.4,1.9,0.2,24,Jan
+6.7,3.0,5.2,2.3,145,Feb
+5.7,3.0,4.2,1.2,95,Feb
+7.1,3.0,5.9,2.1,102,Feb
+5.0,3.5,1.3,0.3,40,Jan
+6.4,3.1,5.5,1.8,137,Feb
+6.7,3.1,4.7,1.5,86,Feb
+5.9,3.2,4.8,1.8,70,Jan
+4.8,3.4,1.6,0.2,11,Jan
+5.2,4.1,1.5,0.1,32,Jan
+6.2,2.2,4.5,1.5,68,Jan
+4.7,3.2,1.6,0.2,29,Jan
+6.1,3.0,4.6,1.4,91,Feb
+6.5,3.0,5.8,2.2,104,Feb
+5.1,2.5,3.0,1.1,98,Feb
+5.1,3.7,1.5,0.4,21,Jan
+7.4,2.8,6.1,1.9,130,Feb
+5.0,3.4,1.5,0.2,7,Jan
+6.8,3.2,5.9,2.3,143,Feb
+6.2,2.8,4.8,1.8,126,Feb
+5.7,4.4,1.5,0.4,15,Jan
+5.6,3.0,4.5,1.5,66,Jan
+6.4,2.8,5.6,2.2,132,Feb
+4.5,2.3,1.3,0.3,41,Jan
+5.5,2.5,4.0,1.3,89,Feb
+5.6,2.5,3.9,1.1,69,Jan
+5.7,2.5,5.0,2.0,113,Feb
+7.0,3.2,4.7,1.4,50,Jan
+6.7,3.0,5.0,1.7,77,Feb
+5.4,3.9,1.3,0.4,16,Jan
+4.9,2.4,3.3,1.0,57,Jan
+5.4,3.4,1.5,0.4,31,Jan
+7.9,3.8,6.4,2.0,131,Feb
+5.9,3.0,5.1,1.8,149,Feb