Skip to content

Commit c1e2f87

Browse files
docs in algorithm file
1 parent 01930d0 commit c1e2f87

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

pyaptamer/mcts/_algorithm.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,6 @@ class MCTS(BaseObject):
3434
experiment : BaseAptamerEval, optional, default=None
3535
An instance of an experiment class definingthe goal function for the algorithm.
3636
37-
Raises
38-
------
39-
ValueError
40-
If ``depth`` is less than 1.
41-
ValueError
42-
If ``n_iterations`` is less than 1.
43-
ValueError
44-
If ``states`` contains duplicate entries.
45-
4637
Attributes
4738
----------
4839
root : TreeNode
@@ -85,6 +76,16 @@ def __init__(
8576
n_iterations: int = 1000,
8677
experiment=None,
8778
) -> None:
79+
"""
80+
Raises
81+
------
82+
ValueError
83+
If `depth` is less than 1.
84+
ValueError
85+
If `n_iterations` is less than 1.
86+
ValueError
87+
If `states` contains duplicate entries.
88+
"""
8889
if depth < 1:
8990
raise ValueError(f"`depth` must be >= 1, got {depth}.")
9091
if n_iterations < 1:

0 commit comments

Comments
 (0)