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.

Sign up for GitHub

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

Jump to bottom

Add DROID dataset example #6149

Merged
merged 6 commits into from
Apr 30, 2024
Merged

Add DROID dataset example #6149

merged 6 commits into from
Apr 30, 2024

Conversation

02alexander
Copy link
Collaborator

@02alexander 02alexander commented Apr 29, 2024 •
edited by github-actions bot
Loading

What

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

@02alexander 02alexander added examples Issues relating to the Rerun examples include in changelog labels Apr 29, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 29, 2024 •
edited
Loading

Deployed docs

Commit Link
ca88a4e https://landing-2jpk61rpv-rerun.vercel.app/docs

nikolausWest
nikolausWest requested changes Apr 29, 2024
View reviewed changes
examples/manifest.toml Outdated
@@ -42,6 +42,7 @@ examples = [
"rrt_star",
"rgbd",
"nv12",
"droid_dataset",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put it first

examples/python/droid_dataset/README.md Outdated
Comment on lines 1 to 11
<!--[metadata]
title = "DROID dataset"
source = "https://github.com/rerun-io/python-example-droid-dataset"
tags = ["2D", "3D", "Depth", "Pinhole camera", "Blueprint"]
thumbnail = "https://static.rerun.io/droid-screenshot-thumbnail.png/87462a48d06a3c2fcc9225ac86df617048c262e6/480w.png"
thumbnail_dimensions = [480, 480]
-->

This example visualizes the [DROID dataset](https://droid-dataset.github.io/), which is a diverse robot manipulation dataset that contains 350 hours of interaction and detailed sensor data.

https://vimeo.com/940717540?autoplay=1&loop=1&autopause=0&background=1&muted=1&ratio=1920:1080
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example README needs some expansion. We've updated how we write these a bit since 0.15. For examples of how we write these now for in-repo examples, see e.g. Controlnet. For external projects (like this one), check out the ROS bridge and VRS examples (you'll find there we still have some room to go on consistency but we're making progress). It should have this structure:

  1. Single line explanation
  2. Screenshot or video
  3. Background section
  4. (Optional) "Logging and visualizing with Rerun" section
  5. "Run the code" section

examples/python/droid_dataset/README.md Outdated
@@ -0,0 +1,11 @@
<!--[metadata]
title = "DROID dataset"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title = "DROID dataset"
title = "DROID"

@02alexander
Copy link
Collaborator Author

I have made the requested changes. I have opted not to include a "Logging and visualizing with Rerun" section because there is quite a lot of repetition in the logging (many scalar time series that needs to be handled differently) and including all of it would make the README quite bloated. Although once this issue is fixed it might be worth to briefly explain in the README how to log joint state using the URDF loader.

nikolausWest
nikolausWest approved these changes Apr 30, 2024
View reviewed changes
Copy link
Member

@nikolausWest nikolausWest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@nikolausWest nikolausWest merged commit 3f56408 into main Apr 30, 2024
33 checks passed
@nikolausWest nikolausWest deleted the alexander/example-droid-add-readme branch April 30, 2024 21:17
nikolausWest pushed a commit that referenced this pull request Apr 30, 2024
@02alexander @nikolausWest
Add DROID dataset example (#6149)
f274121
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nikolausWest nikolausWest nikolausWest approved these changes

Assignees
No one assigned
Labels
examples Issues relating to the Rerun examples include in changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@02alexander @nikolausWest