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

Create blueprints for common examples #5468

Closed
jleibs opened this issue Mar 11, 2024 · 5 comments
Closed

Create blueprints for common examples #5468

jleibs opened this issue Mar 11, 2024 · 5 comments
Assignees
Labels
🟦 blueprint The data that defines our UI examples Issues relating to the Rerun examples
Milestone

Comments

@jleibs
Copy link
Member

jleibs commented Mar 11, 2024

Creating blueprints for the main examples we include on app.rerun.io has a two-fold benefit.

(1) It allows us to validate the blueprint APIs work for the use-cases covered by these examples
(2) Should improve the clarity of the examples themselves once these blueprints are also served as a part of the examples.

Blueprint examples:

Progress / assignee

↪️ == intentionally skipped

Example Assignee / PR
arkit_scenes #5510
blueprint n/a
car removed #5576
clock ↪️ (@Wumpf )
controlnet #5634
depth_guided_stable_diffusion #5582
detect_and_track_objects ↪️ (@Wumpf )
dicom_mri ↪️
dna ↪️ (@Wumpf )
external_data_loader ↪️ (@Wumpf )
face_tracking #5616
gesture_detection #5619
human_pose_tracking #5612
incremental_logging ↪️ (@abey79)
lidar ↪️ (@abey79)
live_camera_edge_detection #5613
live_depth_sensor ↪️ (@Wumpf, wouldn't hurt here but I couldn't run it without the hardware and it looks kinda simple; could a blueprint than rgbd though)
llm_embedding_ner #5614
log_file ↪️ (@Wumpf )
minimal ↪️ (@Wumpf )
minimal_options ↪️ (@Wumpf )
multiprocessing ↪️ (@abey79)
multithreading ↪️ (@abey79)
nuscenes #5556
nv12 ↪️ (@abey79)
objectron #5617
open_photogrammetry_format ↪️ (@abey79)
plots #5517
raw_mesh ↪️
rgbd #5623
ros_node
rrt-star ↪️ (@Wumpf)
segment_anything_model ↪️ (@Wumpf)
shared_recording ↪️ (@Wumpf)
signed_distance_fields #5635
stdio ↪️ (@Wumpf)
structure_from_motion #5572
template ↪️ (@Wumpf)
@jleibs jleibs added examples Issues relating to the Rerun examples 🟦 blueprint The data that defines our UI labels Mar 11, 2024
@jprochazk
Copy link
Member

We should also have blueprints for every snippet, at minimum to disable the timeline and blueprint views.

@abey79
Copy link
Member

abey79 commented Mar 12, 2024

@Wumpf Wumpf added this to the 0.15 milestone Mar 15, 2024
@emilk
Copy link
Member

emilk commented Mar 18, 2024

On the flipside; if an example works well without a blueprint (e.g. Dicom) then I think it makes sense to leave it as is, to also show users that they don't need to set a blueprint

emilk added a commit that referenced this issue Mar 18, 2024
### What
* Part of #5468

An interesting part of this is that the blueprint is dynamically created
based on the the data (which cameras there are).

Before:

![image](https://github.com/rerun-io/rerun/assets/1148717/e8c8c5f2-6502-4325-8268-1067d824494a)


After:

![image](https://github.com/rerun-io/rerun/assets/1148717/60e0673e-5e72-4dc8-8bc3-d5c6e49c7d64)




The 3D camera is (still) too zoomed out, but gathering all the 2D images
in a tab view puts more focus on the 3D view.



### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using newly built examples:
[app.rerun.io](https://app.rerun.io/pr/5556/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/5556/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/5556/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5556)
- [Docs
preview](https://rerun.io/preview/b620da1066ab9c4ba09a3bd0dee813cc3af1de57/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/b620da1066ab9c4ba09a3bd0dee813cc3af1de57/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
@Wumpf Wumpf assigned Wumpf and jleibs and unassigned Wumpf Mar 21, 2024
@emilk
Copy link
Member

emilk commented Mar 22, 2024

We should take a pass adding names to containers where it makes sense

@Wumpf
Copy link
Member

Wumpf commented Mar 22, 2024

did a pass on container names in #5652

@emilk emilk closed this as completed Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🟦 blueprint The data that defines our UI examples Issues relating to the Rerun examples
Projects
None yet
Development

No branches or pull requests

5 participants