From 6d5afa9d55a4212d36a3ad4a4b65af7575bf196c Mon Sep 17 00:00:00 2001
From: Bo Zhou <2466956298@qq.com>
Date: Wed, 19 Aug 2020 21:37:55 +0800
Subject: [PATCH] add docs for distribution of files (#396)
* add docs
* Update distribute_files.md
* Update distribute_files.md
* Update distribute_files.md
* Update distribute_files.md
---
docs/zh_CN/Overview.md | 1 +
docs/zh_CN/xparl/distribute_files.md | 21 +++++++++++++++++++++
2 files changed, 22 insertions(+)
create mode 100644 docs/zh_CN/xparl/distribute_files.md
diff --git a/docs/zh_CN/Overview.md b/docs/zh_CN/Overview.md
index f3d7802..52fd5e5 100644
--- a/docs/zh_CN/Overview.md
+++ b/docs/zh_CN/Overview.md
@@ -77,6 +77,7 @@
使用教程
加速案例
如何debug
+ 分发本地文件
diff --git a/docs/zh_CN/xparl/distribute_files.md b/docs/zh_CN/xparl/distribute_files.md
new file mode 100644
index 0000000..5b8a357
--- /dev/null
+++ b/docs/zh_CN/xparl/distribute_files.md
@@ -0,0 +1,21 @@
+# **如何在xparl中分发本地文件**
+
+文件分发是分布式并行计算的重要功能。它负责把用户的代码还有配置文件分发到不同的机器上，让所有的机器都运行同样的代码进行并行计算。默认情况下，XPARL分发主文件所在目录下，所有py结尾文件。但是有时候用户需要分发一些特定的文件，比如模型文件、配置文件、子目录下的Python代码（用于import的子模块）。为了满足这个需求，parl.connect提供了接口，用户可直接指定需要分发的文件或代码。
+
+### 例子
+
+文件目录结构如下，我们想分发policy文件夹中的py文件。
+我们可以在connect的时候传入想要分发的文件到`distributed_files`参数中，该参数支持正则表达式。
+
+```
+.
+├── main.py
+└── policy
+ ├── agent.py
+ ├── config.ini
+ └── __init__.py
+```
+
+```python
+parl.connect("localhost:8004", distributed_files=['./policy/*.py', './policy/*.ini'])
+```
--
GitLab