Add action masking documentation, update usage scripts #953
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR makes all usage scripts in documentation consistent and uses
break
(rather thanenv.step(None)
, which I personally feel is a bit confusing for new users).I also added action masking documentation to the AEC API page.
I changed the homepage usage script to use
env.action_space(agent).sample()
rather thanpolicy(observation, agent)
just because it feels like it's cleaner to have code which actually runs, but I can change that back if we want.I decided I think this should be removed from both Gymnasium and this (it was added by a new contributor and made the Gym page a bit cluttered, but it's Mark's call, on my other PR in Gymnasium)
Example screenshot of the new homepage:
Action masking documentation:
Fixes # (issue), Depends on # (pull request)
Type of change
Screenshots
Checklist:
pre-commit
checks withpre-commit run --all-files
(seeCONTRIBUTING.md
instructions to set it up)pytest -v
and no errors are present.pytest -v
has generated that are related to my code to the best of my knowledge.