From bcac91a463bd90867974ed6d39b1eda5accdac25 Mon Sep 17 00:00:00 2001
From: qiaolongfei <qiaolongfei@baidu.com>
Date: Wed, 21 Jun 2017 18:21:58 +0800
Subject: [PATCH] scope design doc

---
 doc/refactor/scope.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 doc/refactor/scope.md

diff --git a/doc/refactor/scope.md b/doc/refactor/scope.md
new file mode 100644
index 0000000000..15759d6217
--- /dev/null
+++ b/doc/refactor/scope.md
@@ -0,0 +1,30 @@
+# Scope
+
+### Define
+
+Scope is a context to manage Variables. It mainly contains a map from Variable name to Variable. Net will get and update variable throw scope.
+
+```cpp
+class Scope {
+    Variable GetVar();
+
+private:
+    // var_name -> var
+    std::map<string, Variable> var_map_;
+    Scope* parent_scope_;
+}
+```
+
+You need to specify a scope to run a Net. One net can run in different scopes and update different variable in the scope. If you did not specify one, It will run in a default scope.
+```python
+with ScopeGuard(scope)：
+    Net net = Net();
+    Net.run()
+```
+
+### Chain structure
+
+Scope has a pointer point to it's parent scope, this is mainly used in RNN when it need to create many stepNet.
+
+
+### Scope Guard
\ No newline at end of file
-- 
GitLab