From 530a1eb5ca245da152579e95528d217a5a6bd97d Mon Sep 17 00:00:00 2001 From: Xiong-Hui Chen Date: Sat, 4 Jun 2022 23:50:32 +0800 Subject: [PATCH] update readme. fix typos in yaml --- README.md | 20 +++++++++++--------- example/sb3_ppo_example/rla_config.yaml | 4 ++-- example/sb_ppo_example/rla_config.yaml | 2 +- example/simplest_code/rla_config.yaml | 2 +- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ee394c6..6b715e0 100644 --- a/README.md +++ b/README.md @@ -125,15 +125,18 @@ We build an example project for integrating RLA, which can be seen in ./example/ We record scalars by `RLA.easy_log.logger`: ```python from RLA.easy_log import logger - -# scalar variable -value = 1 -logger.record_tabular("k", value) - -# tensorflow summary import tensorflow as tf -summary = tf.Summary() -logger.log_from_tf_summary(summary) +from RLA.easy_log.time_step import time_step_holder + +for i in range(1000): + # time-steps (iterations) + time_step_holder.set_time(i) + # scalar variable + value = 1 + logger.record_tabular("k", value) + # tensorflow summary + summary = tf.Summary() + logger.log_from_tf_summary(summary) ``` **Record checkpoints** @@ -248,4 +251,3 @@ PS: - [ ] add comments and documents to the functions. - [ ] add an auto integration script. - [ ] download / upload experiment logs through timestamp. - diff --git a/example/sb3_ppo_example/rla_config.yaml b/example/sb3_ppo_example/rla_config.yaml index 51573cf..2a8e9fc 100644 --- a/example/sb3_ppo_example/rla_config.yaml +++ b/example/sb3_ppo_example/rla_config.yaml @@ -18,8 +18,8 @@ LOG_USED: - 'tensorboard' - 'csv' -# select a DL framework: tensorflow or pytorch. -DL_FRAMEWORK: 'pytorch' +# select a DL framework: tensorflow or torch. +DL_FRAMEWORK: 'torch' SEND_LOG_FILE: False REMOTE_SETTING: diff --git a/example/sb_ppo_example/rla_config.yaml b/example/sb_ppo_example/rla_config.yaml index e9472e6..a8224ed 100644 --- a/example/sb_ppo_example/rla_config.yaml +++ b/example/sb_ppo_example/rla_config.yaml @@ -18,7 +18,7 @@ LOG_USED: - 'tensorboard' - 'csv' -# select a DL framework: tensorflow or pytorch. +# select a DL framework: tensorflow or torch. DL_FRAMEWORK: 'tensorflow' SEND_LOG_FILE: False diff --git a/example/simplest_code/rla_config.yaml b/example/simplest_code/rla_config.yaml index dc464f3..65714b3 100644 --- a/example/simplest_code/rla_config.yaml +++ b/example/simplest_code/rla_config.yaml @@ -18,7 +18,7 @@ LOG_USED: - 'tensorboard' - 'csv' -# select a DL framework: tensorflow or pytorch. +# select a DL framework: "tensorflow" or "torch". DL_FRAMEWORK: 'tensorflow' SEND_LOG_FILE: False