Upload README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Table of Contents
|
| 2 |
+
|
| 3 |
+
* [MemoryWritingAtomicFlow](#MemoryWritingAtomicFlow)
|
| 4 |
+
* [MemoryWritingAtomicFlow](#MemoryWritingAtomicFlow.MemoryWritingAtomicFlow)
|
| 5 |
+
* [run\_memwrite](#run_memwrite)
|
| 6 |
+
* [\_\_init\_\_](#__init__)
|
| 7 |
+
|
| 8 |
+
<a id="MemoryWritingAtomicFlow"></a>
|
| 9 |
+
|
| 10 |
+
# MemoryWritingAtomicFlow
|
| 11 |
+
|
| 12 |
+
<a id="MemoryWritingAtomicFlow.MemoryWritingAtomicFlow"></a>
|
| 13 |
+
|
| 14 |
+
## MemoryWritingAtomicFlow Objects
|
| 15 |
+
|
| 16 |
+
```python
|
| 17 |
+
class MemoryWritingAtomicFlow(AtomicFlow)
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
This class is used to write memory to memory files.
|
| 21 |
+
|
| 22 |
+
*Input Interface*:
|
| 23 |
+
- `summary` (str): summary to write to memory file (logs)
|
| 24 |
+
- `memory_files` (dict): dictionary of memory files to write to.
|
| 25 |
+
|
| 26 |
+
*Output Interface*:
|
| 27 |
+
- `MemWrite_output` (str): message that whether memory write was successful
|
| 28 |
+
|
| 29 |
+
<a id="run_memwrite"></a>
|
| 30 |
+
|
| 31 |
+
# run\_memwrite
|
| 32 |
+
|
| 33 |
+
<a id="__init__"></a>
|
| 34 |
+
|
| 35 |
+
# \_\_init\_\_
|
| 36 |
+
|