Skip to content

Commit f4e5337

Browse files
committed
del pack procedure in guidance
1 parent b203ea1 commit f4e5337

File tree

2 files changed

+13
-36
lines changed

2 files changed

+13
-36
lines changed

docs/CONTRIBUTE_TUTORIAL.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -255,35 +255,22 @@ python -m graph_net.config \
255255
256256
```
257257
258-
2. **Package the graph**
258+
2. **Commit the changes**
259259
260+
Move the new sample to **samples** directory and commit.
260261
```bash
261-
python -m graph_net.pack --output /path/to/output.zip --clear-after-pack True
262-
```
263-
264-
This API:
265-
266-
a. Packages all files under `$GRAPH_NET_EXTRACT_WORKSPACE` into `/path/to/output.zip` (You can set it to `GraphNet/samples`)
267-
268-
b. Clears the workspace if `--clear-after-pack` is `True`
269-
270-
Note: If third-party ops are used, contributors must include them manually in the package. As long as `validate` passes, no specific folder structure is required.
271-
272-
3. **Commit the changes**
273-
274-
Move the packaged computational graph in the previous step to **samples** directory and commit.
275-
```bash
276-
git add <the packaged computational graph>
262+
git add <the new sample>
277263
git commit -m "Description"
278264
```
265+
Note: If third-party ops are used, contributors must include them manually in the package.
279266
280-
4. **Push the branch to your fork**
267+
3. **Push the branch to your fork**
281268
282269
```bash
283270
git push origin feature/your-branch-name
284271
```
285272
286-
5. **Submit a Pull Request**
273+
4. **Submit a Pull Request**
287274
288275
> **Note**: For clarity and maintainability, each PR should follow the Single Responsibility Principle (SRP). Submit only a single graph or a focused feature improvement per PR. For example, if you both update extraction logic and collect multiple models, each graph and each method update should be a separate PR.
289276

docs/CONTRIBUTE_TUTORIAL_cn.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -247,32 +247,22 @@ python -m graph_net.config \
247247
--username "john_doe" \
248248
249249
```
250-
2. **打包计算图**
251250

252-
```bash
253-
python -m graph_net.pack --output /path/to/output.zip --clear-after-pack True
254-
```
255-
该API的功能为:
256-
257-
a. 打包`$GRAPH_NET_EXTRACT_WORKSPACE`下的所有文件到`/path/to/output.zip` (可以设置到`GraphNet/samples`
258-
259-
b. 若`--clear-after-pack``True`,则打包后清空`$GRAPH_NET_EXTRACT_WORKSPACE`
251+
2. **提交修改**
260252

261-
请注意,如果有第三方算子,需要贡献者自行打包到计算图压缩包内。目前没有特别规定存放的目录结构,但只要通过了validate环节,就可以达到验收标准。
262-
263-
3. **提交修改**
264-
265-
移动上一步打包完成的计算图压缩包到**samples**目录,然后提交。
253+
移动新增的计算图样本到**samples**目录,然后提交。
266254
```bash
267-
git add <计算图压缩包>
255+
git add <新计算图样本>
268256
git commit -m "描述"
269257
```
270-
4. **推送分支到远程**(你的 Fork 仓库)
258+
请注意,如果有第三方算子,需要贡献者自行打包到计算图压缩包内。
259+
260+
3. **推送分支到远程**(你的 Fork 仓库)
271261

272262
```bash
273263
git push origin feature/your-branch-name
274264
```
275-
5. **提交 Pull Request**
265+
4. **提交 Pull Request**
276266

277267
> **注意**:为方便管理,每个PR应遵守Single Responsibility Principle (SRP)原则,**仅新增单一份计算图、或聚焦于单一功能改进**,避免将多个修改混合提交。例如,如果您修改了抓取方法,然后为支持某类模型收集了数据,那么其中每份单个模型的计算图、修改的新一份抓取方法,都应打开为独立的PR。
278268

0 commit comments

Comments
 (0)