Commit ffe27b32 authored by hazrmard's avatar hazrmard
Browse files

updated README

parent 3221e984
......@@ -137,33 +137,35 @@ Will output the help string:
usage: controller.py [-h] [--use_control USE_CONTROL]
[--control_mean_window CONTROL_MEAN_WINDOW]
[--control_output_threshold CONTROL_OUTPUT_THRESHOLD]
[--control_input_threshold CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD]
[--control_input_fallback CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK]
[--period PERIOD] [--interval INTERVAL]
[--training_duration TRAINING_DURATION] [--demo]
[--dev_server] [--logging {10,20,30,40,50}]
[--control_input_threshold T T T T]
[--control_input_fallback F F F F] [--period PERIOD]
[--interval INTERVAL]
[--training_duration TRAINING_DURATION]
[--relearn_window RELEARN_WINDOW] [--demo] [--dev_server]
[--logging {10,20,30,40,50}] [--halt_on_error]
[read_from] [store_at] [save_to] [is_valid]
Run Alumni Hall controller in a loop.
positional arguments:
read_from File to read Niagra data from.
store_at File to store measurements to.
store_at Directory to store measurements to. Files are named:
YEAR-WEEK-store.csv
save_to File to write control setpoint to.
is_valid File to write the setpoint validity indicator
optional arguments:
-h, --help show this help message and exit
--use_control USE_CONTROL, -c USE_CONTROL
Use existing control policy from file (.h5f)
Prefix of *_[actor|critic].h5f parameters file to use.
--control_mean_window CONTROL_MEAN_WINDOW, -m CONTROL_MEAN_WINDOW
Window of past actions over which to average control.
--control_output_threshold CONTROL_OUTPUT_THRESHOLD
Maximum amount output can change between intervals.
--control_input_threshold CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD CONTROL_INPUT_THRESHOLD
--control_input_threshold T T T T
Maximum amount each input can change between intervals
to be considered normal.
--control_input_fallback CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK CONTROL_INPUT_FALLBACK
--control_input_fallback F F F F
Default input values to infer control from if access
to valid source fails.
--period PERIOD, -p PERIOD
......@@ -173,11 +175,15 @@ optional arguments:
policy.
--training_duration TRAINING_DURATION, -t TRAINING_DURATION
Number of steps to use when re-learning control.
--relearn_window RELEARN_WINDOW, -w RELEARN_WINDOW
Number of past weeks over which to re-learn control.
--demo, -d Run a demo with fake input and output streams.
--dev_server, -x Flag to indicate if it is a development server.
--dev_server, -x Flag to indicate if it is a development server. This
changes read/write paths
--logging {10,20,30,40,50}, -l {10,20,30,40,50}
Logging level (50-critical, 40-error, 30-warning,
20-info, 10-debug).
--halt_on_error Stop controller loop when error occurs.
```
For example:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment