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

refactor: improve consistency of extras #31

Closed
2 tasks
clement-bonnet opened this issue Oct 3, 2022 · 1 comment · Fixed by #44 · May be fixed by dluo96/jumanji#1
Closed
2 tasks

refactor: improve consistency of extras #31

clement-bonnet opened this issue Oct 3, 2022 · 1 comment · Fixed by #44 · May be fixed by dluo96/jumanji#1
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@clement-bonnet
Copy link
Collaborator

clement-bonnet commented Oct 3, 2022

Is your feature request related to a problem? Please describe

The extras field of TimeStep can contain environment information useful for decision-making (e.g. Connect4's current player ID) or environment metrics (e.g. BinPack's volume utilisation). There is an inconsistency in what the extras field is used for as it is sometimes meant to be used by the algorithm and sometimes just logged as a metric.

Describe the solution you'd like

We should move any algorithm-related information from extras to the environment observation (e.g. Connect4's observation could have another field called current_player or something). We should update the documentation/docstrings accordingly to explicitly mention that TimeStep.extras does not contain stuff that is meant to be observed by the agent as those should be in the observation.


TODOs

  • adapt docstrings, doc, codes, etc to make explicit the fact that TimeStep.extras does not contain any info meant to be observed
  • move agent-specific extras (e.g. Connect4's current player ID) to environment observations
@clement-bonnet clement-bonnet added enhancement New feature or request good first issue Good for newcomers labels Oct 3, 2022
@clement-bonnet clement-bonnet added this to the v0.1.2 milestone Nov 7, 2022
@clement-bonnet
Copy link
Collaborator Author

It has been discussed that keeping extras as naming is better than forcing metrics. I am changing the issue description accordingly.

@clement-bonnet clement-bonnet changed the title refactor: change extras to metrics refactor: improve consistency of extras Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
2 participants