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.

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

Review environments documentation #44

Open
FelipeMartins96 opened this issue Oct 7, 2021 · 3 comments
Open

Review environments documentation #44

FelipeMartins96 opened this issue Oct 7, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed

Comments

@FelipeMartins96
Copy link
Member

Each environment code should have a descriptive and correct documentation about the environment, each of the available environemnts should be checked in the information is correct.

@FelipeMartins96 FelipeMartins96 added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest labels Oct 7, 2021
@FelipeMartins96
Copy link
Member Author

Normalized Bounds to [-1.25, 1.25]

Wrong bounds value, this environment uses the VSS base NORM_BOUNDS which is set to 1.2

@LiviaCavalcanti
Copy link

Sorry for my lack of knowlegde, but how should the review proceed? What must be checked to validate environment documentation?

@FelipeMartins96
Copy link
Member Author

Sorry for my lack of knowlegde, but how should the review proceed? What must be checked to validate environment documentation?

I believe that the environment documentation should be a summary of what is implemented on the code, so reviewing it should be about validating for inconsistencies about what the documentation say about the environment and what is implemented on the code.

Inconsistencies arises as modifications were done to the environments code but were not updated on the environment documentation, such as those normalized bounds demonstrated on:

Normalized Bounds to [-1.25, 1.25]

Wrong bounds value, this environment uses the VSS base NORM_BOUNDS which is set to 1.2

Where the observations are normalized using the vss base environment normalization method which has a bound set to 1.2. We believe that there are other documentation errors, so it should be checked. We try to document the following environment information:

  • Description:
  • Observation:
  • Actions:
  • Reward:
  • Starting State:
  • Episode Termination:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed
Development

No branches or pull requests

2 participants