Fix tensorboard_log incrementing note

This commit is contained in:
initrv 2022-12-12 14:35:44 +03:00
parent f9b7d35900
commit f940280d5e

View File

@ -270,7 +270,7 @@ FreqAI also provides a built in episodic summary logger called `self.tensorboard
```
!!! Note
The `self.tensorboard_log()` function is designed for tracking incremented objects only i.e. events, actions inside the training environment. If the event of interest is a float, the float can be passed as the second argument e.g. `self.tensorboard_log("float_metric1", 0.23)` would add 0.23 to `float_metric`.
The `self.tensorboard_log()` function is designed for tracking incremented objects only i.e. events, actions inside the training environment. If the event of interest is a float, the float can be passed as the second argument e.g. `self.tensorboard_log("float_metric1", 0.23)` would add 0.23 to `float_metric`. In this case you can also disable incrementing using `inc=False` parameter.
### Choosing a base environment