update readme

Author: findmyway

README.md

@@ -6,54 +6,65 @@
 
 ## Design
 
+A typical example of `Trajectory`:
+
 ```
-      ┌────────────────────────────┐
-      │(state=..., action=..., ...)│
-      └──────────────┬─────────────┘
-              push!  │  append!
- ┌───────────────────▼───────────────────┐
- │ Trajectory                            │
- │  ┌─────────────────────────────────┐  │
- │  │ Traces                          │  │
- │  │          ┌───────────────────┐  │  │
- │  │   state: │CircularArrayBuffer│  │  │
- │  │          └───────────────────┘  │  │
- │  │          ┌───────────────────┐  │  │
- │  │   action:│CircularArrayBuffer│  │  │
- │  │          └───────────────────┘  │  │
- │  │   ......                        │  │
- │  └─────────────────────────────────┘  │
- |    Sampler                            |
- └───────────────────┬───────────────────┘
-                     │ batch sampling
-      ┌──────────────▼─────────────┐
-      │(state=..., action=..., ...)│
-      └────────────────────────────┘
+╭──── Trajectory ──────────────────────────────────────────────────────────────────────────────────────────────────╮
+│  ╭──── Traces ────────────────────────────────────────────────────────────────────────────────────────────────╮  │
+│  │  ╭──── state: Trac... ────╮╭──── action: Tra... ────╮╭──── reward: Tra... ────╮╭──── terminal: T... ────╮  │  │
+│  │  │  ╭──────────────────╮  ││  ╭──────────────────╮  ││  ╭──────────────────╮  ││  ╭──────────────────╮  │  │  │
+│  │  │  │     SubArray     │  ││  │        1         │  ││  │       1.0        │  ││  │      false       │  │  │  │
+│  │  │  │     (2,3)        │  ││  ╰──────────────────╯  ││  ╰──────────────────╯  ││  ╰──────────────────╯  │  │  │
+│  │  │  ╰──────────────────╯  ││  ╭──────────────────╮  ││  ╭──────────────────╮  ││  ╭──────────────────╮  │  │  │
+│  │  │  ╭──────────────────╮  ││  │        2         │  ││  │       2.0        │  ││  │      false       │  │  │  │
+│  │  │  │     SubArray     │  ││  ╰──────────────────╯  ││  ╰──────────────────╯  ││  ╰──────────────────╯  │  │  │
+│  │  │  │     (2,3)        │  ││  ╭──────────────────╮  ││  ╭──────────────────╮  ││  ╭──────────────────╮  │  │  │
+│  │  │  ╰──────────────────╯  ││  │       ...        │  ││  │       ...        │  ││  │       ...        │  │  │  │
+│  │  │  ╭──────────────────╮  ││  ╰──────────────────╯  ││  ╰──────────────────╯  ││  ╰──────────────────╯  │  │  │
+│  │  │  │       ...        │  ││  ╭──────────────────╮  ││  ╭──────────────────╮  ││  ╭──────────────────╮  │  │  │
+│  │  │  ╰──────────────────╯  ││  │        3         │  ││  │       3.0        │  ││  │       true       │  │  │  │
+│  │  │  ╭──────────────────╮  ││  ╰──────────────────╯  ││  ╰──────────────────╯  ││  ╰──────────────────╯  │  │  │
+│  │  │  │     SubArray     │  ││  ╭──────────────────╮  │╰───────── size: (4,) ───╯╰───────── size: (4,) ───╯  │  │
+│  │  │  │     (2,3)        │  ││  │        3         │  │                                                      │  │
+│  │  │  ╰──────────────────╯  ││  ╰──────────────────╯  │                                                      │  │
+│  │  │  ╭──────────────────╮  │╰───────── size: (5,) ───╯                                                      │  │
+│  │  │  │     SubArray     │  │                                                                                │  │
+│  │  │  │     (2,3)        │  │                                                                                │  │
+│  │  │  ╰──────────────────╯  │                                                                                │  │
+│  │  ╰──── size: (2, 3, 5) ───╯                                                                                │  │
+│  ╰────────────────────────────────────────────────────────────────────────────────────── 4 traces in total ───╯  │
+│  ╭──── sampler ───────────────────────────────────────────────────────╮                                          │
+│  │   BatchSampler                                                     │                                          │
+│  │  ━━━━━━━━━━━━━━                                                    │                                          │
+│  │        │                                                           │                                          │
+│  │        ├── transformer => identity (generic function...: identity  │                                          │
+│  │        ├── rng => Random._GLOBAL_RNG: Random._GLOBAL_RNG()         │                                          │
+│  │        └── batch_size => Int64: 5                                  │                                          │
+│  ╰────────────────────────────────────────────────────────────────────╯                                          │
+│  ╭──── controler ────────────────────────────╮                                                                   │
+│  │   InsertSampleRatioControler              │                                                                   │
+│  │  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━             │                                                                   │
+│  │               │                           │                                                                   │
+│  │               ├── threshold => Int64: 4   │                                                                   │
+│  │               ├── n_sampled => Int64: 0   │                                                                   │
+│  │               ├── ratio => Float64: 0.25  │                                                                   │
+│  │               └── n_inserted => Int64: 4  │                                                                   │
+│  ╰───────────────────────────────────────────╯                                                                   │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
+Exported APIs are:
+
+```julia
+push!(trajectory; [trace_name=value]...)
+append!(trajectory; [trace_name=value]...)
+
+for sample in trajectory
+    # consume samples from the trajectory
+end
 ```
- ┌──────────────┐    ┌──────────────┐
- │Single Element│    │Batch Elements│
- └──────┬───────┘    └──────┬───────┘
-        │                   │
-  push! └──────┐    ┌───────┘ append!
-               │    │
- ┌─────────────┼────┼─────────────────────────────┐
- │          ┌──▼────▼──┐     AsyncTrajectory      │
- │          │Channel In│                          │
- │          └─────┬────┘                          │
- │          take! │                               │
- │          ┌─────▼─────┐   push!  ┌────────────┐ │
- │          │RateLimiter├──────────► Trajectory │ │
- │          └─────┬─────┘  append! └────*───────┘ │
- │                │                     *         │
- │           put! │**********************         │
- │                │     batch sampling            │
- │          ┌─────▼─────┐                         │
- │          │Channel Out│                         │
- │          └───────────┘                         │
- └────────────────────────────────────────────────┘
-```
+
+A wide variety of `container`s, `sampler`s, and `controler`s are provided. For the full list, please read the doc.
 
 ## Acknowledgement