更新英文文档

Author: nan2088

README.md

@@ -23,79 +23,26 @@ Torchpipe is a multi-instance pipeline parallel library that acts as a bridge be
 
 
 
-torchpipe代码正在开源准备中。这里是其（中文）文档站点
+torchpipe代码正在开源准备中。这里是其文档站点
 
-The torchpipe code is being prepared for open sourcing. Here is its (Chinese) documentation site.
+The torchpipe code is being prepared for open sourcing. Here is its documentation site.
 
 
-## updates
-- Some parts of the documentation have been translated into English:
-https://torchpipe.github.io/en/
 
 
 
-## 修改方法
 
-- **文档部分建议优先修改中文版本，路径为：[./i18n/zh/docusaurus-plugin-content-docs/current](./i18n/zh/docusaurus-plugin-content-docs/current)**
-- 您也可以删除中文版的文件，修改英语版本，这样中文版就默认为英语版本的内容；后期再翻译英语版本亦可。
-- 待中文版成熟后，翻译为英语版本
+## edit
 
+- **Chinese version located at：[./i18n/zh/docusaurus-plugin-content-docs/current](./i18n/zh/docusaurus-plugin-content-docs/current)**
 
-## 文档编译
 
-### 启动容器
-```bash
-# remove image if needed
-docker stop docu2 && docker rm docu2
-export your_ip=<your_ip>
-# 修改对外ip和端口（your_ip:port:3000 ）：
-docker run  -p $your_ip:3000:3000 --privileged=true  -v `pwd`:/workspace  --name="docu2"  --cap-add=SYS_PTRACE  -itd   node     
-docker exec -it -w/workspace/ docu2 bash
-```
+## compile
+See [./docs/compile.md](./docs/compile.md)
 
-### 安装依赖
-
-```bash
-yarn add @docusaurus/theme-mermaid
-yarn add @easyops-cn/docusaurus-search-local
-yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest
-```
-
-### 编译并运行
-
-本地预览时，需要将`docusaurus.config.js`中的`url`修改为您的IP
-```bash
-git config --global --add safe.directory /workspace
-
-yarn run build # < repeat this command if u need update the document
-
-npm run serve &
-```
-
-
-
-
-
-### 更新翻译(optinal)
-
-菜单等系统部分的翻译，需要:
-- 将主体用英语书写
-- 再执行：
-```bash
-yarn run write-translations --locale zh
-```
-- 在生成的文件中将对应的英文修改为中文
-
-正文（markdown）部分的翻译：
-- 只翻译较为成熟部分的文档
- 
-
-
-
-### 图标
-
-本项目使用了来自于[IconPark](https://iconpark.oceanengine.com/official)的免费图标(soap-bubble)，其遵循[Apache License 2.0](https://github.com/bytedance/IconPark/blob/master/LICENSE), 并经过ChatGPT4对其矢量图进行调优。
+### Icons
 
+This project utilizes free icons (soap-bubble) from [IconPark](https://iconpark.oceanengine.com/official). These icons are licensed under the [Apache License 2.0](https://github.com/bytedance/IconPark/blob/master/LICENSE) and have been optimized for vector graphics by ChatGPT4.
 
 
 

compile.md

@@ -0,0 +1,44 @@
+
+## compile
+
+### 启动容器
+```bash
+# remove image if needed
+docker stop docu2 && docker rm docu2
+export your_ip=<your_ip>
+# 修改对外ip和端口（your_ip:port:3000 ）：
+docker run  -p $your_ip:3000:3000 --privileged=true  -v `pwd`:/workspace  --name="docu2"  --cap-add=SYS_PTRACE  -itd   node     
+docker exec -it -w/workspace/ docu2 bash
+```
+
+### 安装依赖
+
+```bash
+yarn add @docusaurus/theme-mermaid
+yarn add @easyops-cn/docusaurus-search-local
+yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest
+```
+
+### 编译并运行
+
+```bash
+git config --global --add safe.directory /workspace
+
+yarn run build # < repeat this command if u need update the document
+
+npm run serve &
+```
+接下来，您就可以通过<your_ip>:3000预览文档内容了。
+
+
+
+
+### 更新翻译(optinal)
+
+菜单等系统部分的翻译，需要:
+- 将主体用英语书写
+- 再执行：
+```bash
+yarn run write-translations --locale zh
+```
+- 在生成的文件中将对应的英文修改为中文

docs/backend-reference/basic.mdx

@@ -1,94 +1,71 @@
 ---
 id: basic
-title: 基础性后端
+title: Basic backends
 type: reference
 displayed_sidebar: api
 ---
 
-# 基础性后端
 
 
 
-## 速览
+Overview
 
+| Name                                            | Initialization: Key/Type/Default | Forward Input: Key/Type | Forward Output: Key/Type | Function                      | Note            |
+|-------------------------------------------------|----------------------------------|-------------------------|--------------------------|-------------------------------|-----------------|
+| [`Identity`](#identity)                         | None                             | `data/any`              | `result/any`             | `dict["result"]=dict["data"]` | Default backend |
+| [`Sequential`](#sequential)                     | `Sequential::backend`            | `data/any`              |                          |                               |                 |
+| [`Jump`](../Inter-node/graphtraversal.mdx#jump) | `jump`                           |                         |                          | Jump to other (root) node     |                 |
 
-|名称|初始化：键值/类型/默认值|前向输入：键值/类型|前向输出：键值/类型|功能|备注|
-|---|---|---|---|---|---|
-| [`Identity`](#identity) |无|`data/any`|`result/any`|`dict["result"]=dict["data"]` |默认后端|
-| [`Sequential`](#sequential) |`Sequential::backend`|`data/any`|| || 
-| [`Jump`](../Inter-node/graphtraversal.mdx#jump) |`jump`||| 跳转到其他（根）节点 || 
 
 
-
-
-## 后端展开规则 {#backend-spread}
-对于后端配置，部分后端有进行展开的能力，比如，对于`backend=A[B]`, 可展开为
-```ini
-backend=A
-"A::backend"=B
+## Backend Expansion Rule {#backend-spread}
+For backend configuration, some backends have the ability to expand, for example, for `backend="A[B]"`, it can be expanded to
+```toml
+backend="A"
+"A::backend"="B"
 ```
 
 ## Identity
-什么都不做，只是将输入赋值给输出。
-
+Does nothing but assigns the input to the output.
 
 ## Sequential {#sequential}
-> 具体示例参见[Sequential](../Intra-node/Sequential.mdx)。
+> For specific examples, please refer to [Sequential](../Intra-node/Sequential.mdx).
 
-### 初始化
-`Sequential::backend`可以指定以逗号分开的多个子后端，如`Sequential::backend=A,B,C[D],E`.
-`Sequential`对子后端以[展开规则](#backend-spread)进行展开后得到：
-```ini
-backend=E
+### Initialization
+`Sequential::backend` can specify multiple sub-backends separated by commas, such as `Sequential::backend=A,B,C[D],E`.
+`Sequential` expands sub-backends according to the [backend expansion rules](#backend-spread) to obtain:
+```toml
+backend="E"
 ```
 
-```ini
-backend=C
-C::backend=D
+```toml
+backend="C"
+C::backend="D"
 ```
 
-```ini
-backend=B
+```toml
+backend="B"
 ```
 
-```ini
-backend=A
+```toml
+backend="A"
 ```
-子后端的初始化将按照逆序进行。
+Sub-backend initialization will be performed in reverse order.
 :::info
-`Sequential`可复合使用，如:<br />
+`Sequential` can be composed, for example:<br />
 `S[S[DecodeTensor,ResizeTensor],(or)S[DecodeMat,ResizeMat,Mat2Tensor,SyncTensor],SyncTensor]`.
 :::
-:::tip 重复后端的参数
-Sequential的子后端可能有重复的情况，此时如果需要对子后端指定不同的参数，可以使用`|`符号：
+:::tip Repeating Backend Parameters
+Sub-backends of `Sequential` may have duplicates. If you need to specify different parameters for sub-backends, you can use the `|` symbol:
 ```toml
 backend="Sequential[a,b,Jump,c,Jump]"
 jump="||node_name_1||node_name_2"
 # 或者，任意的占位符都是可以的： 
 # jump="a|b|node_name_1|c|node_name_2"
 ```
 :::
+### Forward
+When forwarding, sub-backends are executed in series. If the result of a non-final sub-backend is empty, the execution is terminated and an exception is thrown. If the result of a non-final sub-backend is non-empty, the filter will be executed. The default is `swap`.
 
-### 前向
-前向时将串行执行子后端；如果非最后的子后端的结果为空，则中止执行，抛出异常；如果非最后的子后端的结果非空，将执行filter. 默认为`swap`.
-
-### 输入范围
-如果子后端输入数据范围都是[1,1], 那么`Sequential`的范围是[1,1], 否则，是输入范围非[1,1]的子后端的输入范围的并集. **目前只允许最多有一个子后端满足`max() != 1 && max() != UINT32_MAX`**. 在Sequential中，目前只允许*最多*放一个输入范围非平凡的子后端，这个子后端可以认为是整个Sequential的主要的功能实现者，其他后端是辅助或者功能性后端。
-
-
-
-
-<!-- | [`Parallel`](#parallel) |`Parallel::backend`|`data/any`|| **将max()提升为UINT32_MAX.**<br />用于并行化执行其他后端（需要后端前向接口线程安全，且线程无关）。可用于并行化[全部opencv相关后端](./opencv.mdx);|对于tensor相关后端或者线程不安全的后端，可使用[Jump](../Inter-node/graphtraversal.mdx#jump)进行节点跳转。| 
-## Parallel
-将后端的输入范围从[1, max]提高到[1,UINT32_MAX], 并行执行后端。
-
-
-
-### 初始化
-:::tip 参数
-- **Parallel::backend** - 后端名，默认为Identity，min()必须是1. 只初始化了一次该后端。
-:::
-
-:::caution
-被提升输入范围的后端的前向接口必须是线程安全的，并且状态不依赖于线程本身。[torch相关后端](./torch.mdx)不被支持
-::: -->
+### Input Range
+If the input data range of all sub-backends is [1,1], then the range of `Sequential` is [1,1]. Otherwise, it is the union of the input ranges of sub-backends whose input ranges are not [1,1]. **Currently, only one sub-backend is allowed to satisfy `max() != 1 && max() != UINT32_MAX` at most**. In `Sequential`, currently only one sub-backend with non-trivial input range is allowed at most, and this sub-backend can be regarded as the main functional implementer of the entire `Sequential`, while other backends are auxiliary or functional backends.

docs/backend-reference/log.mdx

@@ -1,51 +1,48 @@
 ---
 id: log
-title: 日志
+title: Log
 type: reference
 displayed_sidebar: api
 
 ---
-
 :::caution
-本节文档验证中。
+This section of the document is under verification.
 
-- 日志在进程中只初始化一次
-- 日志配置参数直接写在全局参数中
+- The log is only initialized once in the process.
+- Log configuration parameters are directly written in global parameters.
 :::
+## Overview
 
-## 速览
-
-
-|名称|主要初始化参数|备注|
-|---|---|---|---|---|
-| [Logger](#logger) |`Logger::path`,`Logger::maxBytes`<br />`Logger::backupCount`,`Logger::flush_every`<br />`Logger::pattern`  | 默认存在于解释器的环境初始化中(Interpreter::env)，会在解释器初始化时初始化一次.|
+| Name              | Main Initialization Parameters                                                                      | Remarks                                                                                                                                             |
+|-------------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Logger](#logger) | `Logger::path`, `Logger::maxBytes`, `Logger::backupCount`, `Logger::flush_every`, `Logger::pattern` | By default, it exists in the interpreter's environment initialization (Interpreter::env) and is initialized once during interpreter initialization. |
 
 
 
 ## Logger
-实现日志输出功能（包括：控制台输出、文件输出）。
-此后端默认采用控制台输出，如果配置了`Logger::path`参数，将同时输出到path对应的日志文件。
-
-### 初始化
-:::tip 参数
-- **Logger::path** - 指定日志文件路径，如果不指定路径，默认控制台输出日志，指定后，日志将同时在日志文件以及控制台输出。
-- **Logger::maxBytes** - 指定每个日志文件存储的最大空间， 单位是 Byte，仅当指定日志文件路径后生效，取值范围： 1 - 1073741824 (1G)。
-- **Logger::backupCount** - 指定日志文件的最大存储数量，配合Logger::maxBytes参数使用，取值范围：0 - 1024。当取值为0的时候，代表只在指定文件中循环存储，无备份。取值为1的时候，存储文件为：log.txt,log.1.txt，存在一个备份。
-- **Logger::pattern** 设置 [logger的打印模式](https://internal.dunescience.org/doxygen/classspdlog_1_1pattern__formatter.html)。
-   * debug模式下默认值为 `[%l][%m/%d %H:%M:%S][%s:%#%!]: %v`.
-   * release 下默认值为 `[%l][%m/%d %H:%M:%S][%s:%#]: %v`
-- **Logger::flush_every** - 刷新日志到文件的频率，默认为5，单位秒；设置为0代表会刷新每条日志。
+Implements logging functionality (including console output and file output).
+By default, this backend uses console output. If the `Logger::path` parameter is configured, it will also output to the log file corresponding to `path`.
+
+### Initialization
+
+:::tip Parameters
+- **Logger::path** - Specifies the log file path. If no path is specified, the log will be output to the console by default. If a path is specified, the log will be output to both the log file and the console.
+- **Logger::maxBytes** - Specifies the maximum storage space for each log file, in bytes. This parameter only takes effect when a log file path is specified. Valid values are 1-1073741824 (1G).
+- **Logger::backupCount** - Specifies the maximum number of log files to store, used in conjunction with the `Logger::maxBytes` parameter. Valid values are 0-1024. When the value is 0, it means that only the specified file is stored in a circular manner without backup. When the value is 1, the stored files are: log.txt, log.1.txt, with one backup.
+- **Logger::pattern** - Sets the [print mode of the logger](https://internal.dunescience.org/doxygen/classspdlog_1_1pattern__formatter.html).
+   * The default value in debug mode is `[%l][%m/%d %H:%M:%S][%s:%#%!]: %v`.
+   * The default value in release mode is `[%l][%m/%d %H:%M:%S][%s:%#]: %v`.
+- **Logger::flush_every** - Specifies the frequency at which the log is flushed to the file, in seconds. The default value is 5. Setting it to 0 means that every log will be flushed.
 :::
 
 
-<details><summary>示例</summary>
-
+<details><summary>Example</summary>
 ```toml
 "Logger::path" = "./torchpipe.log"  
-# 可选参数，保存日志文件路径，如果不设置，默认控制台输出日志 
+# Optional parameter, specifies the log file path. If not set, the log will be output to the console by default.
 "Logger::maxBytes" = 1048576 #
-# 可选参数，设置后启用循环保存功能，设置单个日志文件存储最大空间，默认值：无穷大。取值范围： 1 - 1073741824 (1G)。 
+# Optional parameter, enables circular storage when set, specifies the maximum storage space for a single log file. Default value: infinity. Valid values are 1-1073741824 (1G).
 "Logger::backupCount" = 20                           
-# 可选参数，配合Logger::maxBytes参数，日志文件的最大保存数量，取值范围： 0 - 1024。
+# Optional parameter, used in conjunction with the `Logger::maxBytes` parameter, specifies the maximum number of log files to store. Valid values are 0-1024.
 ```
 </details>