Skip to content

Commit b682921

Browse files
committed
Doc strings
1 parent 32749f1 commit b682921

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/ReinforcementLearningCore/src/core/reset_conditions.jl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
export ResetAtTerminal, ResetAfterNSteps
22

3+
"""
4+
ResetAtTerminal()
5+
6+
A reset condition that resets if is_terminated(env) is true.
7+
"""
38
struct ResetAtTerminal end
49

510
(::ResetAtTerminal)(policy, env) = is_terminal(env)
611

12+
"""
13+
ResetAfterNSteps(n)
14+
15+
A reset condition that resets after `n` steps in the environment.
16+
"""
717
mutable struct ResetAfterNSteps
818
t::Int
919
n::Int

0 commit comments

Comments
 (0)