Skip to content

Commit 676d735

Browse files
authored
Update TrainerParamOverride.md
1 parent a8ab515 commit 676d735

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

Documents/TrainerParamOverride.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
11
# TrainerParamOverride
2+
3+
If you need your trainer parameters to change over the training process(which quite often is needed), for example, decreasing the learning rate, you can use this helper script to easily to do that.
4+
5+
For any trainer that inherits from `Trainer` class on a GameObject, you can also attach the script TrainerParamOverride.cs to the GameObject to modify the parameters during the training based on training steps.
6+
7+
<p align="center">
8+
<img src="Images/Training/TrainerParamOverride.png"
9+
alt="TrainerParamOverride"
10+
width="400" border="10" />
11+
</p>
12+
13+
The `overrides` array defines all the parameters you want to change during the training and how to change them.
14+
15+
For each override, there are two fields:
16+
* name: The name of the parameter you want to change. The name should be the name in the scriptable object script, not the one shown in inspector(because unity added spaces between words and captilize the first letter).
17+
* curve: The changing curve of the parameter. The x axis of the curve is the ratio between (current steps of trainer)/(maxTotalSteps defined in the trainer parameter). The y axis of the curve is the factor to multiply on the initial value of that parameter defined in the trainer parameter.

0 commit comments

Comments
 (0)