-
-
Notifications
You must be signed in to change notification settings - Fork 49
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
Update docs with EpisodeData info #109
Update docs with EpisodeData info #109
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One change, otherwise, looks good!
docs/content/dataset_standards.md
Outdated
| `id` | `np.int64` | ID of the episode. | | ||
| `seed` | `np.int64` | Seed used to reset the episode. | | ||
| `total_timesteps` | `np.int64` | Number of timesteps in the episode. | | ||
| `observations` | `np.ndarray` | Observations for each timestep including initial observation. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Observations and actions are not necessary represented as a single np.ndarray
; it's worth looking at episodes from the various dummy envs used in test_dataset_creation.py
, to get an idea of what is possible for observations and action types.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@balisujohn I updated the data types with the test spaces I saw in the test_dataset_creation.py
and common.py
files. Let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found the types tuple
, list
and dict
, and numpy.ndarray
from when I added at line 74 of test_dataset_creation.py:
print(type(dataset[0].observations))
It might be fair to say List[str]
though if so, I'd confirm that string spaces are the only context where lists occur.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, I updated data types. When it comes to list
I only saw data type List[str]
in datasets created in test_dataset_creation.py but left it as list
in case there's some other dataset type I'm missing.
LGTM :^) |
Description
This PR adds a section to the
Dataset Standards
documentation page describing theEpisodeData
data structure and the fields it contains. Also includes a small snippet of sampling episodes from a Minari dataset.Type of change
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.