rerun-io · emilk · Feb 11, 2023 · Feb 10, 2023 · Feb 10, 2023 · Feb 10, 2023
diff --git a/.flake8 b/.flake8
@@ -25,10 +25,10 @@ extend-exclude =
     target/,
 
     # generated
-    examples/objectron/dataset/proto/objectron/proto.py,
+    examples/python/objectron/proto/objectron/proto.py,
 
     # Copied from https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_depth2img.py
-    examples/stable_diffusion/huggingface_pipeline.py,
+    examples/python/stable_diffusion/huggingface_pipeline.py,
 
     # Copied from https://github.com/colmap/colmap/blob/bf3e19140f491c3042bfd85b7192ef7d249808ec/scripts/python/read_write_model.py
-    examples/colmap/read_write_model.py,
+    examples/python/colmap/read_write_model.py,
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -4,7 +4,7 @@ on:
   pull_request:
     paths:
       - "rerun_py/**"
-      - "examples/**"
+      - "examples/python/**"
       - ".github/workflows/python.yml"
   push:
     branches:
@@ -152,8 +152,8 @@ jobs:
       - name: Generate Embedded RRD file
         shell: bash
         run: |
-          pip install -r examples/car/requirements.txt
-          python examples/car/main.py --headless --save car.rrd
+          pip install -r examples/python/car/requirements.txt
+          python examples/python/car/main.py --headless --save car.rrd
           cp car.rrd rerun_py/rerun_sdk/rerun_demo/demo.rrd
 
       - name: Build Wheel
@@ -179,8 +179,8 @@ jobs:
 
       - name: Run Car example
         run: |
-          pip install -r examples/car/requirements.txt
-          ./examples/car/main.py --headless
+          pip install -r examples/python/car/requirements.txt
+          ./examples/python/car/main.py --headless
 
       - name: Upload wheels
         uses: actions/upload-artifact@v3

diff --git a/.mypy.ini b/.mypy.ini
@@ -1,6 +1,6 @@
 [mypy]
-files = rerun_py/rerun_sdk/rerun, rerun_py/tests, examples
-exclude = examples/objectron/dataset/proto
+files = rerun_py/rerun_sdk/rerun, rerun_py/tests, examples/python
+exclude = examples/python/objectron/proto
 namespace_packages = True
 show_error_codes = True
 strict = True

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,14 +1,6 @@
 [workspace]
 resolver = "2"
-members = [
-  "crates/*",
-  "rerun_py",
-  "run_wasm",
-  "examples/api_demo",
-  "examples/minimal",
-  "examples/objectron",
-  "examples/raw_mesh",
-]
+members = ["crates/*", "examples/rust/*", "rerun_py", "run_wasm"]
 
 [workspace.package]
 authors = ["rerun.io <[email protected]>"]

diff --git a/examples/README.md b/examples/README.md
@@ -1,35 +1 @@
-# Rerun Examples
-The simplest example is [`minimal`](minimal/main.py). You may want to start there!
-
-## Setup
-First install the Rerun Python SDK with `pip install rerun-sdk` (coming soon!)
-
-<!-- TODO(emilk): remove the coming soon -->
-
-## Dependencies
-Each example comes with its own set of dependencies listed in a `requirements.txt` file. For example, to install dependencies and run the toy `car` example (which doesn't need to download any data) run:
-
-```sh
-pip install -r examples/car/requirements.txt
-examples/car/main.py
-```
-
-You can also install all dependencies needed to run all examples with:
-
-```sh
-pip install -r examples/requirements.txt
-```
-
-## Running the examples
-By default, the examples spawn a Rerun Viewer and stream log data to it.
-
-You can instead save the log data to an `.rrd` file using `examples/car/main.py --save data.rrd`. You can then open that `.rrd` file with `rerun data.rrd`.
-
-(`rerun` is an alias for `python -m rerun`).
-
-NOTE: `.rrd` files do not yet guarantee any backwards or forwards compatibility. One version of Rerun will likely not be able to open an `.rrd` file generated by another Rerun version.
-
-## Contributions welcome
-Feel free to open a PR to add a new example!
-
-See [`CONTRIBUTING.md`](../CONTRIBUTING.md) for details on how to contribute.
+# Official Rerun examples
diff --git a/examples/deep_sdf/dataset/.gitignore b/examples/deep_sdf/dataset/.gitignore
diff --git a/examples/objectron/dataset/.gitignore b/examples/objectron/dataset/.gitignore
diff --git a/examples/objectron/dataset/compile_protobuf.sh b/examples/objectron/dataset/compile_protobuf.sh
diff --git a/examples/objectron/dataset/proto/__init__.py b/examples/objectron/dataset/proto/__init__.py
diff --git a/examples/objectron/dataset/proto/objectron/__init__.py b/examples/objectron/dataset/proto/objectron/__init__.py
diff --git a/examples/python/README.md b/examples/python/README.md
@@ -0,0 +1,38 @@
+# Rerun Examples
+The simplest example is [`minimal`](minimal/main.py). You may want to start there!
+
+## Setup
+First install the Rerun Python SDK with `pip install rerun-sdk` (coming soon!)
-First install the Rerun Python SDK with `pip install rerun-sdk` (coming soon!)
+First install the Rerun Python SDK with `pip install rerun-sdk`.
-First install the Rerun Python SDK with `pip install rerun-sdk` (coming soon!)
+First install the Rerun Python SDK with `pip install rerun-sdk`.
+
+<!-- TODO(emilk): remove the coming soon -->
-<!-- TODO(emilk): remove the coming soon -->
-<!-- TODO(emilk): remove the coming soon -->
+
+## Dependencies
+Each example comes with its own set of dependencies listed in a `requirements.txt` file. For example, to install dependencies and run the toy `car` example (which doesn't need to download any data) run:
+
+```sh
+pip install -r examples/python/car/requirements.txt
+examples/python/car/main.py
+```
+
+You can also install all dependencies needed to run all examples with:
+
+```sh
+pip install -r examples/python/requirements.txt
+```
+
+## Running the examples
+By default, the examples spawn a Rerun Viewer and stream log data to it.
+
+You can instead save the log data to an `.rrd` file using `examples/python/car/main.py --save data.rrd`. You can then open that `.rrd` file with `rerun data.rrd`.
+
+(`rerun` is an alias for `python -m rerun`).
+
+NOTE: `.rrd` files do not yet guarantee any backwards or forwards compatibility. One version of Rerun will likely not be able to open an `.rrd` file generated by another Rerun version.
+
+## Datasets
+Some examples will download a small datasets before they run. They will do so the first time you run the example. The datasets will be added to a subdir called `dataset`, which is in the repo-wide `.gitignore`.
+
+## Contributions welcome
+Feel free to open a PR to add a new example!
+
+See [`CONTRIBUTING.md`](../CONTRIBUTING.md) for details on how to contribute.
diff --git a/examples/__init__.py → examples/python/__init__.py b/examples/__init__.py → examples/python/__init__.py
diff --git a/examples/api_demo/main.py → examples/python/api_demo/main.py b/examples/api_demo/main.py → examples/python/api_demo/main.py
@@ -3,8 +3,8 @@
 Minimal examples of Rerun SDK usage.
 
 Example usage:
-* Run all demos: `examples/api_demo/main.py`
-* Run specific demo: `examples/api_demo/main.py --demo rects`
+* Run all demos: `examples/python/api_demo/main.py`
+* Run specific demo: `examples/python/api_demo/main.py --demo rects`
 """
 
 import argparse

diff --git a/examples/api_demo/requirements.txt → examples/python/api_demo/requirements.txt b/examples/api_demo/requirements.txt → examples/python/api_demo/requirements.txt
diff --git a/examples/car/main.py → examples/python/car/main.py b/examples/car/main.py → examples/python/car/main.py
diff --git a/examples/car/requirements.txt → examples/python/car/requirements.txt b/examples/car/requirements.txt → examples/python/car/requirements.txt
diff --git a/examples/clock/main.py → examples/python/clock/main.py b/examples/clock/main.py → examples/python/clock/main.py
diff --git a/examples/clock/requirements.txt → examples/python/clock/requirements.txt b/examples/clock/requirements.txt → examples/python/clock/requirements.txt
diff --git a/examples/colmap/.gitignore → examples/python/colmap/.gitignore b/examples/colmap/.gitignore → examples/python/colmap/.gitignore
diff --git a/examples/colmap/main.py → examples/python/colmap/main.py b/examples/colmap/main.py → examples/python/colmap/main.py
diff --git a/examples/colmap/read_write_model.py → examples/python/colmap/read_write_model.py b/examples/colmap/read_write_model.py → examples/python/colmap/read_write_model.py
diff --git a/examples/colmap/requirements.txt → examples/python/colmap/requirements.txt b/examples/colmap/requirements.txt → examples/python/colmap/requirements.txt
diff --git a/examples/deep_sdf/.gitignore → examples/python/deep_sdf/.gitignore b/examples/deep_sdf/.gitignore → examples/python/deep_sdf/.gitignore
diff --git a/examples/deep_sdf/dataset/dataset.py → examples/python/deep_sdf/download_dataset.py b/examples/deep_sdf/dataset/dataset.py → examples/python/deep_sdf/download_dataset.py
@@ -10,16 +10,16 @@
 
 # TODO(cmc): re-enable obj meshes when we support those on the viewer's side
 AVAILABLE_MESHES: Final = [
+    "lantern",
     "avocado",
+    "buggy",
     "brain_stem",
     # "buddha",
-    "buggy",
     # "bunny",
     # "dragon",
-    "lantern",
     # "mori_knob",
 ]
-DOWNLOADED_DIR: Final = Path(os.path.dirname(__file__)) / "downloaded"
+DOWNLOADED_DIR: Final = Path(os.path.dirname(__file__)) / "dataset"
 
 
 def ensure_mesh_downloaded(mesh_name: str) -> Path:
@@ -67,7 +67,7 @@ def download_mcguire_sample(package: str, name: str) -> Path:
     }
     url = f"https://casual-effects.com/g3d/data10/{package}/model/{name}/{name}.zip"
 
-    dir = Path(os.path.dirname(__file__)) / "downloaded"
+    dir = Path(os.path.dirname(__file__)) / "dataset"
     os.makedirs(dir, exist_ok=True)
 
     def download_and_extract(url: str, path: Path) -> None:

diff --git a/examples/deep_sdf/main.py → examples/python/deep_sdf/main.py b/examples/deep_sdf/main.py → examples/python/deep_sdf/main.py
@@ -23,7 +23,7 @@
 Run:
 ```sh
 # assuming your virtual env is up
-examples/deep_sdf/main.py
+examples/python/deep_sdf/main.py
 ```
 """
 
@@ -38,7 +38,7 @@
 import numpy as np
 import numpy.typing as npt
 import trimesh
-from dataset.dataset import AVAILABLE_MESHES, ensure_mesh_downloaded
+from download_dataset import AVAILABLE_MESHES, ensure_mesh_downloaded
 from rerun.log.file import MeshFormat
 from rerun.log.text import LogLevel
 from trimesh import Trimesh

diff --git a/examples/deep_sdf/requirements.txt → examples/python/deep_sdf/requirements.txt b/examples/deep_sdf/requirements.txt → examples/python/deep_sdf/requirements.txt
diff --git a/examples/dicom/.gitignore → examples/python/dicom/.gitignore b/examples/dicom/.gitignore → examples/python/dicom/.gitignore
diff --git a/examples/dicom/main.py → examples/python/dicom/main.py b/examples/dicom/main.py → examples/python/dicom/main.py
@@ -4,7 +4,7 @@
 
 Run:
 ``` sh
-python3 examples/dicom/main.py
+python3 examples/python/dicom/main.py
 ```
 """
 

diff --git a/examples/dicom/requirements.txt → examples/python/dicom/requirements.txt b/examples/dicom/requirements.txt → examples/python/dicom/requirements.txt
diff --git a/examples/minimal/main.py → examples/python/minimal/main.py b/examples/minimal/main.py → examples/python/minimal/main.py
diff --git a/examples/minimal/requirements.txt → examples/python/minimal/requirements.txt b/examples/minimal/requirements.txt → examples/python/minimal/requirements.txt
diff --git a/examples/mp_pose/.gitignore → examples/python/mp_pose/.gitignore b/examples/mp_pose/.gitignore → examples/python/mp_pose/.gitignore
diff --git a/examples/mp_pose/main.py → examples/python/mp_pose/main.py b/examples/mp_pose/main.py → examples/python/mp_pose/main.py
@@ -135,6 +135,10 @@ def get_downloaded_path(dataset_dir: Path, video_name: str) -> str:
 
 
 def main() -> None:
+    # Ensure the logging gets written to stderr:
+    logging.getLogger().addHandler(logging.StreamHandler())
+    logging.getLogger().setLevel("INFO")
+
     parser = argparse.ArgumentParser(description="Uses the MediaPipe Pose solution to track a human pose in video.")
     parser.add_argument(
         "--video",

diff --git a/examples/mp_pose/requirements.txt → examples/python/mp_pose/requirements.txt b/examples/mp_pose/requirements.txt → examples/python/mp_pose/requirements.txt
diff --git a/examples/multiprocessing/main.py → examples/python/multiprocessing/main.py b/examples/multiprocessing/main.py → examples/python/multiprocessing/main.py
diff --git a/examples/multiprocessing/requirements.txt → ...s/python/multiprocessing/requirements.txt b/examples/multiprocessing/requirements.txt → ...s/python/multiprocessing/requirements.txt
diff --git a/examples/multithreading/main.py → examples/python/multithreading/main.py b/examples/multithreading/main.py → examples/python/multithreading/main.py
diff --git a/examples/multithreading/requirements.txt → ...es/python/multithreading/requirements.txt b/examples/multithreading/requirements.txt → ...es/python/multithreading/requirements.txt
diff --git a/examples/nyud/.gitignore → examples/python/nyud/.gitignore b/examples/nyud/.gitignore → examples/python/nyud/.gitignore
diff --git a/examples/nyud/main.py → examples/python/nyud/main.py b/examples/nyud/main.py → examples/python/nyud/main.py
diff --git a/examples/nyud/requirements.txt → examples/python/nyud/requirements.txt b/examples/nyud/requirements.txt → examples/python/nyud/requirements.txt
diff --git a/examples/objectron/dataset/dataset.py → ...ples/python/objectron/download_dataset.py b/examples/objectron/dataset/dataset.py → ...ples/python/objectron/download_dataset.py
@@ -7,7 +7,7 @@
 import requests
 
 DATASET_BASE_URL = "https://storage.googleapis.com/objectron"
-LOCAL_DATASET_DIR: Final = Path(os.path.dirname(__file__)) / "downloaded"
+LOCAL_DATASET_DIR: Final = Path(os.path.dirname(__file__)) / "dataset"
 IMAGE_RESOLUTION: Final = (1440, 1920)
 GEOMETRY_FILENAME: Final = "geometry.pbdata"
 ANNOTATIONS_FILENAME: Final = "annotation.pbdata"
@@ -29,7 +29,7 @@
 def ensure_downloaded(src_url: str, dst_path: Path) -> None:
     os.makedirs(dst_path.parent, exist_ok=True)
     if not dst_path.exists():
-        logging.info("Downloading from %s to %s", src_url, dst_path)
+        logging.info("Downloading %s to %s", src_url, dst_path)
         with requests.get(src_url, stream=True) as req:
             req.raise_for_status()
             with open(dst_path, "wb") as f:

diff --git a/examples/objectron/main.py → examples/python/objectron/main.py b/examples/objectron/main.py → examples/python/objectron/main.py
@@ -3,11 +3,11 @@
 """
 Example of using the Rerun SDK to log the Objectron dataset.
 
-Example: `examples/objectron/main.py --recording chair`
+Example: `examples/python/objectron/main.py --recording chair`
 """
 
-
 import argparse
+import logging
 import math
 import os
 import sys
@@ -18,15 +18,15 @@
 
 import numpy as np
 import numpy.typing as npt
-from dataset.dataset import (
+from download_dataset import (
     ANNOTATIONS_FILENAME,
     AVAILABLE_RECORDINGS,
     GEOMETRY_FILENAME,
     IMAGE_RESOLUTION,
     LOCAL_DATASET_DIR,
     ensure_recording_available,
 )
-from dataset.proto.objectron.proto import (
+from proto.objectron.proto import (
     ARCamera,
     ARFrame,
     ARPointCloud,
@@ -256,6 +256,10 @@ def log_projected_bbox(path: str, keypoints: npt.NDArray[np.float32]) -> None:
 
 
 def main() -> None:
+    # Ensure the logging in download_dataset.py gets written to stderr:
+    logging.getLogger().addHandler(logging.StreamHandler())
+    logging.getLogger().setLevel("INFO")
+
     parser = argparse.ArgumentParser(description="Logs Objectron data using the Rerun SDK.")
     parser.add_argument(
         "--frames", type=int, default=sys.maxsize, help="If specified, limits the number of frames logged"

diff --git a/examples/objectron/dataset/proto/LICENSE.txt → examples/python/objectron/proto/LICENSE.txt b/examples/objectron/dataset/proto/LICENSE.txt → examples/python/objectron/proto/LICENSE.txt
diff --git a/examples/deep_sdf/dataset/__init__.py → examples/python/objectron/proto/__init__.py b/examples/deep_sdf/dataset/__init__.py → examples/python/objectron/proto/__init__.py
diff --git a/.../dataset/proto/a_r_capture_metadata.proto → ...bjectron/proto/a_r_capture_metadata.proto b/.../dataset/proto/a_r_capture_metadata.proto → ...bjectron/proto/a_r_capture_metadata.proto
diff --git a/...ctron/dataset/proto/annotation_data.proto → ...hon/objectron/proto/annotation_data.proto b/...ctron/dataset/proto/annotation_data.proto → ...hon/objectron/proto/annotation_data.proto
diff --git a/...ples/objectron/dataset/proto/object.proto → examples/python/objectron/proto/object.proto b/...ples/objectron/dataset/proto/object.proto → examples/python/objectron/proto/object.proto
diff --git a/examples/objectron/dataset/__init__.py → ...hon/objectron/proto/objectron/__init__.py b/examples/objectron/dataset/__init__.py → ...hon/objectron/proto/objectron/__init__.py
diff --git a/...bjectron/dataset/proto/objectron/proto.py → ...python/objectron/proto/objectron/proto.py b/...bjectron/dataset/proto/objectron/proto.py → ...python/objectron/proto/objectron/proto.py
diff --git a/examples/objectron/requirements.txt → examples/python/objectron/requirements.txt b/examples/objectron/requirements.txt → examples/python/objectron/requirements.txt
diff --git a/examples/plots/main.py → examples/python/plots/main.py b/examples/plots/main.py → examples/python/plots/main.py
@@ -5,7 +5,7 @@
 
 Run:
 ```sh
-./examples/plot/main.py
+./examples/python/plot/main.py
 ```
 """
 

diff --git a/examples/plots/requirements.txt → examples/python/plots/requirements.txt b/examples/plots/requirements.txt → examples/python/plots/requirements.txt
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,7 @@ @@
     Run:
     ``` sh
-    python3 examples/dicom/main.py
+    python3 examples/python/dicom/main.py
     ```
     """
@@ Expand Down @@