Skip to content

Adding documentation for learning rate schedule #3603

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

Merged
merged 2 commits into from
Mar 10, 2020

Conversation

anupam-142857
Copy link

Proposed change(s)

Added a description of learning_rate_schedule in the docs

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

#3328
https://jira.unity3d.com/browse/MLA-751

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

@@ -190,6 +190,7 @@ example environments are included in the provided config file.
| init_entcoef | How much the agent should explore in the beginning of training. | SAC |
| lambd | The regularization parameter. | PPO |
| learning_rate | The initial learning rate for gradient descent. | PPO, SAC |
| learning_rate_schedule | Determines how learning rate changes over time. Options: linear (default), constant | PPO, SAC |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The defaults are actually different for PPO and SAC - would just leave out the options as they're specified within the PPO/SAC docs

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we provide a link to the PPO/SAC docs here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's a link at the top of the table

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes made. can you please approve?

@anupam-142857 anupam-142857 merged commit 97e4fea into master Mar 10, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs-learning-rate-schedule branch March 10, 2020 20:46
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants