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

Provide a template / skeleton code for adding loaders for specific file formats #205

Open
sfmig opened this issue Jun 4, 2024 · 0 comments
Labels
enhancement New optional feature

Comments

@sfmig
Copy link
Contributor

sfmig commented Jun 4, 2024

Is your feature request related to a problem? Please describe.
We would like to make it very easy for contributors to add support to a variety of file formats.

Right now, it can be a bit tricky to find your way around validators and movement data structures, especially for first time contributors.

Describe the solution you'd like
Chatting with @niksirbi, he suggested providing in the docs a 'template' for:

  • a load_poses.from_<generic_file> function, which takes the required file format and extracts the required numpy arrays for the dataset (see here for example).
  • a Valid<generic_file> validator, that does specific checks for that file format.

Describe alternatives you've considered

  • A README/text guide with steps. This may still be needed as a complement.

Additional context
Add any other context or screenshots about the feature request here.

@sfmig sfmig added the enhancement New optional feature label Jun 4, 2024
@sfmig sfmig moved this to 🤔 Triage in movement progress tracker Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New optional feature
Projects
Status: 🤔 Triage
Development

No branches or pull requests

1 participant