From 85094d874e439d27991e4b8e25c583d03ea2bcef Mon Sep 17 00:00:00 2001
From: TomorrowIsAnOtherDay <2466956298@qq.com>
Date: Wed, 19 Aug 2020 15:01:20 +0800
Subject: [PATCH] add docs

---
 docs/zh_CN/Overview.md               |  1 +
 docs/zh_CN/xparl/distribute_files.md | 20 ++++++++++++++++++++
 2 files changed, 21 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 e724695..2d795ed 100644
--- a/docs/zh_CN/Overview.md
+++ b/docs/zh_CN/Overview.md
@@ -77,6 +77,7 @@
             <li><a href="xparl/tutorial.md">使用教程</a></li>
             <li><a href="xparl/example.md">加速案例</a></li>
             <li><a href="xparl/debug.md">如何debug</a></li>
+            <li><a href="xparl/distribute_files.md">分发本地文件</a></li>
             </ul>
       </td>
     </tr>
diff --git a/docs/zh_CN/xparl/distribute_files.md b/docs/zh_CN/xparl/distribute_files.md
new file mode 100644
index 0000000..672cf6f
--- /dev/null
+++ b/docs/zh_CN/xparl/distribute_files.md
@@ -0,0 +1,20 @@
+# **如何在xparl中分发本地文件**
+
+文件分发是分布式并行计算的重要功能。它负责把用户的代码还有配置文件分发到不同的机器上，让所有的机器都运行同样的代码进行并行计算。默认情况下，XPARL分发主文件所在目录下，所有py结尾文件。但是有时候用户需要分发一些特定的文件，比如在代码中import 了子模块（目录下）的代码。为了解决这个问题，用户可以通过parl的接口来显式地指定需要分发的文件或者代码。
+
+### 例子
+
+文件目录结构如下，我们想分发policy文件夹中的py文件，我们可以在connect的时候传入想要分发的文件到`distributed_files`参数中，该参数支持正则表达式。
+
+```
+.
+├── main.py
+└── policy
+    ├── agent.py
+    ├── config.ini
+    └── __init__.py
+```
+
+```python
+parl.connect("localhost:8004", distributed_files=['./policy/*.py'])
+```
\ No newline at end of file
-- 
GitLab