Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstrings #142

Merged
merged 1 commit into from Aug 29, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions chainerrl/action_value.py
Expand Up @@ -41,7 +41,7 @@ def evaluate_actions(self, actions):


class DiscreteActionValue(ActionValue):
"""Qfunction output for discrete action space.
"""Q-function output for discrete action space.

Args:
q_values (ndarray or chainer.Variable):
Expand Down Expand Up @@ -95,7 +95,7 @@ def __repr__(self):


class QuadraticActionValue(ActionValue):
"""Qfunction output for continuous action space.
"""Q-function output for continuous action space.

See: http://arxiv.org/abs/1603.00748

Expand Down
4 changes: 2 additions & 2 deletions chainerrl/v_functions/v_functions.py
Expand Up @@ -16,11 +16,11 @@

class SingleModelVFunction(
chainer.Chain, VFunction, RecurrentChainMixin):
"""Q-function with discrete actions.
"""V-function

Args:
model (chainer.Link):
Link that is callable and outputs action values.
Link that is callable, inputs states, and outputs state values.
"""

def __init__(self, model):
Expand Down
2 changes: 1 addition & 1 deletion examples/gym/train_a3c_gym.py
@@ -1,6 +1,6 @@
"""An example of training A3C against OpenAI Gym Envs.

This script is an example of training a PCL agent against OpenAI Gym envs.
This script is an example of training a A3C agent against OpenAI Gym envs.
Both discrete and continuous action spaces are supported.

To solve CartPole-v0, run:
Expand Down
4 changes: 2 additions & 2 deletions examples/gym/train_reinforce_gym.py
Expand Up @@ -4,10 +4,10 @@
envs. Both discrete and continuous action spaces are supported.

To solve CartPole-v0, run:
python train_pcl_gym.py
python train_reinforce_gym.py

To solve InvertedPendulum-v1, run:
python train_pcl_gym.py --env InvertedPendulum-v1
python train_reinforce_gym.py --env InvertedPendulum-v1
"""
from __future__ import division
from __future__ import print_function
Expand Down