Skip to content

Commit

Permalink
[ci skip] Doc fix
Browse files Browse the repository at this point in the history
DeepQ -> DQN
  • Loading branch information
araffin committed Sep 18, 2018
1 parent 221f012 commit 70898bd
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ All the following examples can be executed online using Google colab notebooks:
| ACER | :heavy_check_mark: | :heavy_check_mark: | :x: <sup>(5)</sup> | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: |
| ACKTR | :heavy_check_mark: | :heavy_check_mark: | :x: <sup>(5)</sup> | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: |
| DDPG | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: |
| DeepQ | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: | :x: | :x: |
| DQN | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: | :x: | :x: |
| GAIL <sup>(2)</sup> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :x: | :heavy_check_mark: <sup>(4)</sup> |
| HER <sup>(3)</sup> | :x: <sup>(5)</sup> | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: |
| PPO1 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: <sup>(4)</sup> |
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/dqn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Example
del model # remove to demonstrate saving and loading
DeepQ.load("deepq_cartpole")
DQN.load("deepq_cartpole")
obs = env.reset()
while True:
Expand Down
2 changes: 1 addition & 1 deletion stable_baselines/deepq/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

def wrap_atari_dqn(env):
"""
wrap the environment in atari wrappers for DeepQ
wrap the environment in atari wrappers for DQN
:param env: (Gym Environment) the environment
:return: (Gym Environment) the wrapped environment
Expand Down
6 changes: 3 additions & 3 deletions stable_baselines/deepq/build_graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def build_act(q_func, ob_space, ac_space, stochastic_ph, update_eps_ph, sess):
"""
Creates the act function:
:param q_func: (DeepQPolicy) the policy
:param q_func: (DQNPolicy) the policy
:param ob_space: (Gym Space) The observation space of the environment
:param ac_space: (Gym Space) The action space of the environment
:param stochastic_ph: (TensorFlow Tensor) the stochastic placeholder
Expand Down Expand Up @@ -166,7 +166,7 @@ def build_act_with_param_noise(q_func, ob_space, ac_space, stochastic_ph, update
"""
Creates the act function with support for parameter space noise exploration (https://arxiv.org/abs/1706.01905):
:param q_func: (DeepQPolicy) the policy
:param q_func: (DQNPolicy) the policy
:param ob_space: (Gym Space) The observation space of the environment
:param ac_space: (Gym Space) The action space of the environment
:param stochastic_ph: (TensorFlow Tensor) the stochastic placeholder
Expand Down Expand Up @@ -324,7 +324,7 @@ def build_train(q_func, ob_space, ac_space, optimizer, sess, grad_norm_clipping=
"""
Creates the train function:
:param q_func: (DeepQPolicy) the policy
:param q_func: (DQNPolicy) the policy
:param ob_space: (Gym Space) The observation space of the environment
:param ac_space: (Gym Space) The action space of the environment
:param reuse: (bool) whether or not to reuse the graph variables
Expand Down
2 changes: 1 addition & 1 deletion stable_baselines/deepq/dqn.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class DQN(OffPolicyRLModel):
"""
The DQN model class. DQN paper: https://arxiv.org/pdf/1312.5602.pdf
:param policy: (DeepQPolicy or str) The policy model to use (MlpPolicy, CnnPolicy, LnMlpPolicy, ...)
:param policy: (DQNPolicy or str) The policy model to use (MlpPolicy, CnnPolicy, LnMlpPolicy, ...)
:param env: (Gym environment or str) The environment to learn from (if registered in Gym, can be str)
:param gamma: (float) discount factor
:param learning_rate: (float) learning rate for adam optimizer
Expand Down
4 changes: 1 addition & 3 deletions stable_baselines/deepq/experiments/custom_cartpole.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def __init__(self, *args, **kwargs):

def main(args):
"""
Train a DeepQ agent on cartpole env
Train a DQN agent on cartpole env
:param args: (Parsed Arguments) the input arguments
"""
with tf_utils.make_session(8) as sess:
Expand Down Expand Up @@ -99,5 +99,3 @@ def main(args):
help="Maximum number of timesteps when not rendering")
args = parser.parse_args()
main(args)


2 changes: 1 addition & 1 deletion stable_baselines/deepq/experiments/enjoy_mountaincar.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

def main(args):
"""
run a trained model for the mountain car problem
Run a trained model for the mountain car problem
:param args: (ArgumentParser) the input arguments
"""
Expand Down
2 changes: 1 addition & 1 deletion stable_baselines/deepq/experiments/enjoy_pong.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

def main():
"""
run a trained model for the pong problem
Run a trained model for the pong problem
"""
env = gym.make("PongNoFrameskip-v4")
env = deepq.wrap_atari_dqn(env)
Expand Down
2 changes: 1 addition & 1 deletion stable_baselines/deepq/experiments/run_atari.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

def main():
"""
run the atari test
Run the atari test
"""
parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('--env', help='environment ID', default='BreakoutNoFrameskip-v4')
Expand Down
4 changes: 2 additions & 2 deletions stable_baselines/deepq/experiments/train_cartpole.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

def callback(lcl, _glb):
"""
the callback function for logging and saving
The callback function for logging and saving
:param lcl: (dict) the local variables
:param _glb: (dict) the global variables
Expand All @@ -25,7 +25,7 @@ def callback(lcl, _glb):

def main(args):
"""
train and save the DeepQ model, for the cartpole problem
Train and save the DQN model, for the cartpole problem
:param args: (ArgumentParser) the input arguments
"""
Expand Down
2 changes: 1 addition & 1 deletion stable_baselines/deepq/experiments/train_mountaincar.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def __init__(self, *args, **kwargs):

def main(args):
"""
train and save the DeepQ model, for the mountain car problem
Train and save the DQN model, for the mountain car problem
:param args: (ArgumentParser) the input arguments
"""
Expand Down

0 comments on commit 70898bd

Please sign in to comment.