Skip to content

Commit 6562eca

Browse files
corrects docstring format for parameters
1 parent bc03a2d commit 6562eca

File tree

1 file changed

+19
-24
lines changed

1 file changed

+19
-24
lines changed

axelrod/strategies/dbs.py

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,25 @@ class DBS(Player):
2222
article. When noise increases you can try to diminish
2323
violation_threshold and rejection_threshold
2424
25-
Parameters:
26-
27-
discount_factor: (float, between 0 and 1) discount factor used when
28-
computing discounted frequencies to learn opponent's strategy
29-
defaults = .75
30-
31-
promotion_threshold: (int) number of observations needed to promote
32-
a change in opponent's strategy
33-
defaults = 3
34-
35-
violation_threshold: (int) number of observation needed to
36-
considerate opponent's strategy has changed. Seems good to
37-
lower it when noise increases
38-
defaults = 4
39-
40-
reject_threshold: (int) number of observations before forgetting
41-
opponents old strategy. Seems good to lower it when noise
42-
increases
43-
default = 3
44-
45-
tree_depth: (int) depth of the tree for the tree-search algorithm.
46-
default is 5.
47-
Higher depth means more time to coompute the move.
48-
25+
Parameters
26+
----------
27+
discount_factor : float, optional
28+
used when computing discounted frequencies to learn opponent's
29+
strategy. Must be between 0 and 1. The default is 0.75
30+
promotion_threshold : int, optional
31+
number of observations needed to promote a change in opponent's
32+
strategy. The default is 3.
33+
violation_threshold : int, optional
34+
number of observations needed to considerate opponent's
35+
strategy has changed. You can lower it when noise increases.
36+
The default is 4, which is good for a noise level of .1
37+
reject_threshold : int, optional
38+
number of observations before forgetting opponent's previous
39+
strategy. You can lower it when noise increases. The default
40+
is 3, which is good for a noise level of .1
41+
tree_depth: int, optional
42+
depth of the tree for the tree-search algorithm. Higher depth
43+
means more time to compute the move. The default is 5
4944
"""
5045

5146
# These are various properties for the strategy

0 commit comments

Comments
 (0)