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

Turn all in-repo python examples into mini-tutorials #5435

Open
2 tasks done
nikolausWest opened this issue Mar 8, 2024 · 7 comments
Open
2 tasks done

Turn all in-repo python examples into mini-tutorials #5435

nikolausWest opened this issue Mar 8, 2024 · 7 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Milestone

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Mar 8, 2024

After #5434, add the "Logging and Visualizing with Rerun" section to all example READMEs, in effect turning them into mini-tutorials on how to use Rerun.

@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples labels Mar 8, 2024
@nikolausWest nikolausWest added this to the Triage milestone Mar 8, 2024
@BirgerMoell
Copy link
Contributor

I'll get started with the controlnet demo.

@BirgerMoell
Copy link
Contributor

@nikolausWest first draft for a updated controlnet demo.
#5490

@andreasnaoum
Copy link
Contributor

@BirgerMoell Hey man, I suggest using my Notion page to document what we have done and what is pending.

Here's a public link where you can edit online:
https://rerunio.notion.site/READMEs-15f2e82ab1e44b7cb62e91209ae6c8b2?pvs=4

I started updating them firstly with Intro, Rerun Types and Run sections, and later I will add the Background and Logging sections.

@andreasnaoum
Copy link
Contributor

andreasnaoum commented Mar 21, 2024

#5620 Updated READMEs:

Detect and Track Objects
Dicom MRI
Face Tracking
Gesture Detection
Human Pose Tracking
LiDAR
Live Camera Edge Detection
Live Depth Sensor

@andreasnaoum
Copy link
Contributor

#5653 Updated READMEs for the examples:

LLM Embedding-Based Named Entity Recognition
nuScenes
Objectron
Open Photogrammetry Format
Raw Mesh

@andreasnaoum
Copy link
Contributor

Updated READMEs for the examples:

RGBD
Segment Anything Model
Signed Distance Fields
Structure from Motion
ROS Node (+ setup/dependencies, no explanation just referred to documentation)

@andreasnaoum
Copy link
Contributor

Updated READMEs for the examples:

Minimal Example
Clock
Multithreading
Multiprocessing
Plots

The last comment and this one is related to this pull request: #5784

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Projects
None yet
Development

No branches or pull requests

3 participants