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.

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

Jump to bottom

Update CartPole reward documentation #429

Merged
merged 1 commit into from Apr 3, 2023
Merged

Update CartPole reward documentation #429

merged 1 commit into from Apr 3, 2023

Conversation

robertoschiavone
Copy link
Contributor

@robertoschiavone robertoschiavone commented Apr 3, 2023 •
edited

Description

The maximum reward is equal to the maximum episode length.

Type of change

  • Documentation update

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

pseudo-rnd-thoughts
pseudo-rnd-thoughts reviewed Apr 3, 2023
View reviewed changes
gymnasium/envs/classic_control/cartpole.py Outdated
@@ -58,7 +58,7 @@ class CartPoleEnv(gym.Env[np.ndarray, Union[int, np.ndarray]]):
## Rewards

Since the goal is to keep the pole upright for as long as possible, a reward of `+1` for every step taken,
including the termination step, is allotted. The threshold for rewards is 475 for v1.
including the termination step, is allotted. The threshold for rewards is 500 for v1.
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for fixing this, could we have a note for v0 as well, that the maximum reward is 200

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done! I've updated the branch

@robertoschiavone
fix: cartpole documentation 📝
ad96401 
The maximum reward is equal to the maximum episode length.
@pseudo-rnd-thoughts pseudo-rnd-thoughts changed the title fix: cartpole documentation 📝 Update CartPole reward documentation Apr 3, 2023
@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 066b843 into Farama-Foundation:main Apr 3, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pseudo-rnd-thoughts pseudo-rnd-thoughts pseudo-rnd-thoughts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@robertoschiavone @pseudo-rnd-thoughts