Docs: Env attributes should be modified using env setters #1789
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.
This PR aims at solving #1573.
In the issue, I documented how directly accessing environment attributes might have an unexpected outcome when dealing with Vectorized environments, and that one should instead invoke the
env_method
method of VecEnv passing in a setter for the environment considered.This is relevant in use-cases where one uses callbacks modifying environments during training (typical in multi-task/meta-RL scenarios).
In this PR, I present:
Description
I have added a new paragraph to
vec_envs.rst
, explaining in detail the rationale behind this problem. I have also presented an example of use case where this very same problem might arise, and a scheme of the solution (both on the environment and callback side).Motivation and Context
This change introduce a new paragraph into the documentation aiming at solving the unexpected behavior of directly accessing environment attributes via dot notation.
#1573
closes #1573
Types of changes
Checklist
make format
(required)make check-codestyle
andmake lint
(required)make pytest
andmake type
both pass. (required)make doc
(required)Note: You can run most of the checks using
make commit-checks
.Note: we are using a maximum length of 127 characters per line