add disclaimers everywhere about how example strategies are meant as examples

This commit is contained in:
robcaulk
2023-05-12 08:16:48 +00:00
parent ad2080ab3e
commit 31d15da49e
8 changed files with 50 additions and 7 deletions

View File

@@ -371,6 +371,12 @@ class BaseReinforcementLearningModel(IFreqaiModel):
"""
An example reward function. This is the one function that users will likely
wish to inject their own creativity into.
Warning!
This is function is a showcase of functionality designed to show as many possible
environment control features as possible. It is also designed to run quickly
on small computers. This is a benchmark, it is *not* for live production.
:param action: int = The action made by the agent for the current candle.
:return:
float = the reward to give to the agent for current step (used for optimization