You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: danling/runner/README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -4,26 +4,26 @@ The Runner of DanLing sets up the basic environment for running neural networks.
4
4
5
5
## Components
6
6
7
-
For cross-platform compatibilities, DanLing features a two-level Runner + RunnerState system.
7
+
For cross-platform compatibilities, DanLing features a two-level Runner + Config system.
8
8
9
9
### PlatformRunner
10
10
11
11
PlatformRunner implements platform-specific features like `step` and `prepare`.
12
12
13
-
The Runner contains all runtime information that is irrelevant to the checkpoint (e.g. `world_size`, `rank`, etc.). All other information should be saved in `RunnerState`.
13
+
The Runner contains all runtime information that is irrelevant to the checkpoint (e.g. `world_size`, `rank`, etc.). All other information should be saved in `Config`.
14
14
15
15
Currently, only [`AccelerateRunner`][danling.runner.AccelerateRunner] is supported.
16
16
17
17
### [`BaseRunner`][danling.runner.BaseRunner]
18
18
19
-
[`BaseRunner`](danling.runner.BaseRunner) defines shared attributes and implements platform-agnostic features, including `init_logging`, `results` and `scores`.
19
+
[`BaseRunner`][danling.runner.BaseRunner] defines shared attributes and implements platform-agnostic features, including `init_logging`, `results` and `scores`.
20
20
21
-
### [`RunnerState`][danling.runner.RunnerState]
21
+
### [`Config`][danling.runner.Config]
22
22
23
-
[`RunnerState`][danling.runner.RunnerState] stores the state of a run (e.g. `epochs`, `run_id`, `network`, etc.).
23
+
[`Config`][danling.runner.Config] stores the state of a run (e.g. `epoch`, `run_id`, `network`, etc.).
24
24
25
-
With `RunnerState` and corresponding weights, you can resume a run from any point.
26
-
Therefore, all members in `RunnerState` will be saved in the checkpoint, and thus should be json serialisable.
25
+
With `Config` and corresponding weights, you can resume a run from any point.
26
+
Therefore, all members in `Config` will be saved in the checkpoint, and thus should be json serialisable.
0 commit comments