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

[Feature Request] Provide documentation on how to use CatFrames with a data collector and replay buffer for images #2618

Open
1 task done
AlexandreBrown opened this issue Nov 29, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@AlexandreBrown
Copy link

AlexandreBrown commented Nov 29, 2024

Motivation

Using CatFrames for inference is fairly straightforward and is already well documented.
That being said, using CatFrames to reconstruct a stack of frames when sampling from the replay buffer is not so straightforward I find (subjective) and is not explicitly documentd for images (objective).
Using frame stacking for Visual RL is very common practice so I feel like the community would benefit from getting a better documentation on how to use CatFrames for images.

Solution

Provide a clear documentation that explains everything in details (no magic flags/magic values) on how to use CatFrames with a data collector and replay buffer (both extend and sample() method should be shown) for images.

I have created a gist of my attempt to use CatFrames for images and while the inference part works, the stack frames retrieved from the replay buffer do not make sense.

https://gist.github.com/AlexandreBrown/fe378f26a87bdc40c5995dcc7d42f482

Any help on how to make the last part where we sample from the replay buffer return the correct CatFrames data is appreciated.

Contributions

I am willing to work on the PR for the documentation update if someone can help me get the MVP script working.

Checklist

  • I have checked that there is no similar issue in the repo (required)
@AlexandreBrown AlexandreBrown added the enhancement New feature or request label Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants