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

Update titles and tags for examples with real data #2416

Merged
merged 18 commits into from
Jun 14, 2023
Merged

Conversation

nikolausWest
Copy link
Member

@nikolausWest nikolausWest commented Jun 13, 2023

What

Updates the titles, and adds tags to all "python examples with real data" (a separate PR is needed for the "fake data" examples).

Renames:

before after
arkitscenes arkit_scenes
colmap structure_from_motion
deep_sdf signed_distance_fields
dicom dicom_mri
mp_pose human_pose_tracking
nyud  rgbd
opencv_canny live_camera_edge_detection
ros ros_node
segment_anything segment_anything_model
stable_diffusion depth_guided_stable_diffusion
tracking_hf_opencv detect_and_track_objects

In order to minimise merge issues, this is best updated and merged AFTER:

TODO

  • Update names script names
  • Update any references to the scripts
  • Mirror updates for Rust examples (none of the renamed examples have rust counterparts)
  • Convert tags to list
  • Quick typo/grammar pass with pycharm's checker

Checklist

PR Build Summary: https://build.rerun.io/pr/2416

Docs preview: https://rerun.io/preview/3fb07ee/docs
Examples preview: https://rerun.io/preview/3fb07ee/examples

@abey79 abey79 self-assigned this Jun 13, 2023
examples/manifest.yml Outdated Show resolved Hide resolved
@abey79 abey79 added the examples Issues relating to the Rerun examples label Jun 14, 2023
@emilk emilk mentioned this pull request Jun 14, 2023
1 task
emilk added a commit that referenced this pull request Jun 14, 2023
Closes #2260

### What
I've updated the list of examples to use at demo.rerun.io.

Sizes are pretty good now with JPEG compression, and all of these will
be streamed once we have #2262
(except DICOM, which is just one big tensor)

```
arkitscenes:         42.7 MB
colmap:               7.6 MB
dicom:               67.7 MB
mp_pose:             58.2 MB
plots:                0.1 MB
tracking_hf_opencv:  58.2 MB
```

The CSS here could use some work though in a folllow-up PR:

![image](https://github.com/rerun-io/rerun/assets/1148717/0ac44586-6438-4976-b959-2e0f327b989f)

Some of the names here have been updated, following the lead of
#2416

### How to test it
```
scripts/build_demo_app.py
(cd web_demo && basic-http-server -a 0.0.0.0:8080 .)
```

This will also require a manual deploy to `demo.rerun.io` at some point.

### 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)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2420

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/07dd16b/docs
Examples preview: https://rerun.io/preview/07dd16b/examples
<!-- pr-link-docs:end -->
@abey79 abey79 marked this pull request as ready for review June 14, 2023 13:41
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

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

Much better names!

It would be nice with a table of before-and-after names in the PR description so I can learn the new names!

scripts/build_demo_app.py Outdated Show resolved Hide resolved
scripts/run_all.py Outdated Show resolved Hide resolved
@abey79 abey79 merged commit 7c59e05 into main Jun 14, 2023
@abey79 abey79 deleted the niko/rename-examples branch June 14, 2023 15:46
emilk added a commit that referenced this pull request Jun 15, 2023
Closes #2260

### What
I've updated the list of examples to use at demo.rerun.io.

Sizes are pretty good now with JPEG compression, and all of these will
be streamed once we have #2262
(except DICOM, which is just one big tensor)

```
arkitscenes:         42.7 MB
colmap:               7.6 MB
dicom:               67.7 MB
mp_pose:             58.2 MB
plots:                0.1 MB
tracking_hf_opencv:  58.2 MB
```

The CSS here could use some work though in a folllow-up PR:

![image](https://github.com/rerun-io/rerun/assets/1148717/0ac44586-6438-4976-b959-2e0f327b989f)

Some of the names here have been updated, following the lead of
#2416

### How to test it
```
scripts/build_demo_app.py
(cd web_demo && basic-http-server -a 0.0.0.0:8080 .)
```

This will also require a manual deploy to `demo.rerun.io` at some point.

### 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)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2420

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/07dd16b/docs
Examples preview: https://rerun.io/preview/07dd16b/examples
<!-- pr-link-docs:end -->
emilk pushed a commit that referenced this pull request Jun 15, 2023
Updates the titles, and adds tags to all "python examples with real
data" (a separate PR is needed for the "fake data" examples).

Renames:

| before | after |
| --- | --- |
| arkitscenes | arkit_scenes |
| colmap | structure_from_motion |
| deep_sdf | signed_distance_fields |
| dicom | dicom_mri |
| mp_pose | human_pose_tracking |
| nyud | rgbd |
| opencv_canny | live_camera_edge_detection |
| ros | ros_node |
| segment_anything | segment_anything_model |
| stable_diffusion | depth_guided_stable_diffusion |
| tracking_hf_opencv | detect_and_track_objects |

In order to minimise merge issues, this is best updated and merged
AFTER:
- #2419
- #2420
- #2418
- #2424
- #2426
- #2360

TODO

- [x] Update names script names
- [x] Update any references to the scripts
- [ ] ~~Mirror updates for Rust examples~~ (none of the renamed examples
have rust counterparts)
- [x] Convert tags to list
- [x] Quick typo/grammar pass with pycharm's checker

* [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)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2416

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/3fb07ee/docs
Examples preview: https://rerun.io/preview/3fb07ee/examples
<!-- pr-link-docs:end -->

---------

Co-authored-by: Antoine Beyeler <[email protected]>
@emilk emilk mentioned this pull request Jun 15, 2023
3 tasks
@emilk
Copy link
Member

emilk commented Jun 15, 2023

The old names are still being referred to in some places. For instance, scripts/demo_assets/static/index.html refers to examples/colmap (which doesn't exist), and we are using colmap_fiat as a name in many places

@emilk emilk mentioned this pull request Jun 15, 2023
1 task
@abey79 abey79 mentioned this pull request Jun 15, 2023
2 tasks
emilk pushed a commit that referenced this pull request Jun 15, 2023
### What

This PR fixes a bunch of places where renames from #2416 weren't
applied.

⚠️ It touches various build-related places, ~~due to the renaming of
`colmap_fiat.rrd` into `structure_from_motion_fiat.rrd`~~, which is
included in the SDK demo feature.

Edit: `colmap_fiat.rrd` shouldn't be renamed, it corresponds to an
actual Google dataset called `colmap_fiat`.

### 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)
* [ ] ~~I've included a screenshot or gif (if applicable)~~ 

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2448

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/98e0eca/docs
Examples preview: https://rerun.io/preview/98e0eca/examples
<!-- pr-link-docs:end -->
emilk pushed a commit that referenced this pull request Jun 15, 2023
### What

This PR fixes a bunch of places where renames from #2416 weren't
applied.

⚠️ It touches various build-related places, ~~due to the renaming of
`colmap_fiat.rrd` into `structure_from_motion_fiat.rrd`~~, which is
included in the SDK demo feature.

Edit: `colmap_fiat.rrd` shouldn't be renamed, it corresponds to an
actual Google dataset called `colmap_fiat`.

### 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)
* [ ] ~~I've included a screenshot or gif (if applicable)~~ 

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2448

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/98e0eca/docs
Examples preview: https://rerun.io/preview/98e0eca/examples
<!-- pr-link-docs:end -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Issues relating to the Rerun examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants