Skip to content

Commit 20c4a51

Browse files
authored
Fix doc for EpisodeData and StepData (#310)
1 parent c1e11b5 commit 20c4a51

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/api/minari_dataset/episode_data.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
3131
Stacked actions taken in each episode step.
3232
33+
.. autoattribute:: minari.EpisodeData.rewards
34+
35+
The ``reward`` value after each environment step.
36+
3337
.. autoattribute:: minari.EpisodeData.terminations
3438
3539
The ``terminated`` value after each environment step.

docs/api/minari_dataset/step_data.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,15 @@
1818
1919
The action performed by the agent on the environment.
2020
21-
.. autoattribute:: minari.StepData.termination
21+
.. autoattribute:: minari.StepData.reward
22+
23+
The ``reward`` value returned by the environment after performing the action.
24+
25+
.. autoattribute:: minari.StepData.terminated
2226
2327
The ``terminated`` value returned by the environment after performing the action.
2428
25-
.. autoattribute:: minari.StepData.truncation
29+
.. autoattribute:: minari.StepData.truncated
2630
2731
The ``truncated`` value returned by the environment after performing the action.
2832

0 commit comments

Comments
 (0)