Skip to content

add fire clean up docstrings in create policies #4391

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 20, 2020
Merged

add fire clean up docstrings in create policies #4391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ee1cb3
clean up docstrings create policies
andrewcoh Aug 20, 2020
7899905
capitalize Tensorflow
andrewcoh Aug 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions ml-agents/mlagents/trainers/ppo/trainer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,10 @@ def create_tf_policy(
create_graph: bool = False,
) -> TFPolicy:
"""
Creates a PPO policy to trainers list of policies.
Creates a policy with a Tensorflow backend and PPO hyperparameters
:param parsed_behavior_id:
:param behavior_spec: specifications for policy construction
:param create_graph: whether to create the graph when policy is constructed
:param create_graph: whether to create the Tensorflow graph on construction
:return policy
"""
policy = TFPolicy(
Expand All @@ -234,9 +235,9 @@ def create_torch_policy(
self, parsed_behavior_id: BehaviorIdentifiers, behavior_spec: BehaviorSpec
) -> TorchPolicy:
"""
Creates a PPO policy to trainers list of policies.
Creates a policy with a PyTorch backend and PPO hyperparameters
:param parsed_behavior_id:
:param brain_parameters: specifications for policy construction
:param behavior_spec: specifications for policy construction
:return policy
"""
policy = TorchPolicy(
Expand Down
9 changes: 8 additions & 1 deletion ml-agents/mlagents/trainers/sac/trainer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,13 @@ def create_tf_policy(
behavior_spec: BehaviorSpec,
create_graph: bool = False,
) -> TFPolicy:
"""
Creates a policy with a Tensorflow backend and SAC hyperparameters
:param parsed_behavior_id:
:param behavior_spec: specifications for policy construction
:param create_graph: whether to create the Tensorflow graph on construction
:return policy
"""
policy = TFPolicy(
self.seed,
behavior_spec,
Expand All @@ -248,7 +255,7 @@ def create_torch_policy(
self, parsed_behavior_id: BehaviorIdentifiers, behavior_spec: BehaviorSpec
) -> TorchPolicy:
"""
Creates a PPO policy to trainers list of policies.
Creates a policy with a PyTorch backend and SAC hyperparameters
:param parsed_behavior_id:
:param behavior_spec: specifications for policy construction
:return policy
Expand Down