Skip to content

Commit b1b247b

Browse files
committed
docs: Add policy documentation links to policy_kwargs parameter
1 parent 897d01d commit b1b247b

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

stable_baselines3/a2c/a2c.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class A2C(OnPolicyAlgorithm):
4848
:param stats_window_size: Window size for the rollout logging, specifying the number of episodes to average
4949
the reported success rate, mean episode length, and mean reward over
5050
:param tensorboard_log: the log location for tensorboard (if None, no logging)
51-
:param policy_kwargs: additional arguments to be passed to the policy on creation
51+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`a2c_policies`
5252
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
5353
debug messages
5454
:param seed: Seed for the pseudo random generators

stable_baselines3/ddpg/ddpg.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class DDPG(TD3):
4444
:param optimize_memory_usage: Enable a memory efficient variant of the replay buffer
4545
at a cost of more complexity.
4646
See https://github.com/DLR-RM/stable-baselines3/issues/37#issuecomment-637501195
47-
:param policy_kwargs: additional arguments to be passed to the policy on creation
47+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`ddpg_policies`
4848
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
4949
debug messages
5050
:param seed: Seed for the pseudo random generators

stable_baselines3/dqn/dqn.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class DQN(OffPolicyAlgorithm):
5353
:param stats_window_size: Window size for the rollout logging, specifying the number of episodes to average
5454
the reported success rate, mean episode length, and mean reward over
5555
:param tensorboard_log: the log location for tensorboard (if None, no logging)
56-
:param policy_kwargs: additional arguments to be passed to the policy on creation
56+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`dqn_policies`
5757
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
5858
debug messages
5959
:param seed: Seed for the pseudo random generators

stable_baselines3/ppo/ppo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class PPO(OnPolicyAlgorithm):
6262
:param stats_window_size: Window size for the rollout logging, specifying the number of episodes to average
6363
the reported success rate, mean episode length, and mean reward over
6464
:param tensorboard_log: the log location for tensorboard (if None, no logging)
65-
:param policy_kwargs: additional arguments to be passed to the policy on creation
65+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`ppo_policies`
6666
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
6767
debug messages
6868
:param seed: Seed for the pseudo random generators

stable_baselines3/sac/sac.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class SAC(OffPolicyAlgorithm):
6868
:param stats_window_size: Window size for the rollout logging, specifying the number of episodes to average
6969
the reported success rate, mean episode length, and mean reward over
7070
:param tensorboard_log: the log location for tensorboard (if None, no logging)
71-
:param policy_kwargs: additional arguments to be passed to the policy on creation
71+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`sac_policies`
7272
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
7373
debug messages
7474
:param seed: Seed for the pseudo random generators

stable_baselines3/td3/td3.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class TD3(OffPolicyAlgorithm):
5656
:param stats_window_size: Window size for the rollout logging, specifying the number of episodes to average
5757
the reported success rate, mean episode length, and mean reward over
5858
:param tensorboard_log: the log location for tensorboard (if None, no logging)
59-
:param policy_kwargs: additional arguments to be passed to the policy on creation
59+
:param policy_kwargs: additional arguments to be passed to the policy on creation. See :ref:`td3_policies`
6060
:param verbose: Verbosity level: 0 for no output, 1 for info messages (such as device or wrappers used), 2 for
6161
debug messages
6262
:param seed: Seed for the pseudo random generators

0 commit comments

Comments
 (0)