manifest.toml

#:schema ./schema.json

# Examples listed in this manifest will appear on our website.
# This has no effect whatsoever on whether they appear in the app itself.
#
# To add examples to the app itself, use the `channel` attribute in the example's readme's frontmatter.
# See <https://github.com/rerun-io/rerun/tree/main/examples#adding-a-new-example> for more information.

[categories.spatial-computing]
order = 1
title = "Spatial computing and XR"
prelude = """
Examples related to spatial computing, augmented reality, virtual reality, and mixed reality.
"""
examples = [
  # display order, most interesting first
  "arkit_scenes",
  "limap",
  "objectron",
  "simplerecon",
  "slahmr",
  "vrs",
  "widebaseline",
  "arflow",
]

[categories.robotics]
order = 2
title = "Robotics"
prelude = """
Examples related to robotics, autonomous systems, and interfacing with sensor hardware.
"""
examples = [
  # display order, most interesting first
  "droid_dataset",
  "ros_node",
  "chess_robby_fischer",
  "nuscenes_dataset",
  "ros2_bridge",
  "ros_bridge",
  "kiss-icp",
  "urdf_loader",
  "live_depth_sensor",
  "lidar",
  "rrt_star",
  "rgbd",
  "nv12",
]

[categories.generative-vision]
order = 3
title = "Diffusion models, LLMs, and machine learning"
prelude = """
Examples using machine learning and generative AI methods such as diffusion and LLMs.
"""
examples = [
  # display order, most interesting first
  "controlnet",
  "depth_guided_stable_diffusion",
  "vista",
  "mcc",
  "lerobot",
  "depth_compare",
  "mini_nvs_solver",
  "shape_pointe",
  "llm_embedding_ner",
  "tfrecord_loader",
]

[categories.video-image]
order = 4
title = "Image and video understanding"
prelude = """
Examples related to image and video processing, highlighting Rerun's 2D capabilities.
"""
examples = [
  # display order, most interesting first
  "detect_and_track_objects",
  "face_tracking",
  "human_pose_tracking",
  "gesture_detection",
  "ocr",
  "live_camera_edge_detection",
  "segment_anything_model",
  "tapir",
]

[categories.3d-reconstruction] # NOLINT
order = 5
title = "3D reconstruction and modelling"
prelude = """
SLAM, photogrammetry and other 3D modelling examples.
"""
examples = [
  # display order, most interesting first
  "structure_from_motion",
  "open_photogrammetry_format",
  "kiss-icp",
  "differentiable_blocks_world",
  "stereo_vision_slam",
  "glomap",
  "signed_distance_fields",
  "raw_mesh",
]

[categories.integrations]
order = 6
title = "Integrations"
prelude = """
Integration with 3rd party tools, formats, libraries, and APIs.
"""
examples = [
  # display order, most interesting first
  "ros_node",
  "ros2_bridge",
  "ros_bridge",
  "notebook",
  "notebook_neural_field_2d",
  "urdf_loader",
  "vrs",
  "revy",
  "tfrecord_loader",
  "eigen_opencv",
  "dicom_mri",
  "blueprint_stocks",
  "arflow",
]

[categories.feature-showcase]
order = 7
title = "Feature showcase"
prelude = """
Showcase basic usage and specific features of Rerun.
"""
examples = [
  # display order, most interesting first
  "notebook",
  "clock",
  "dna",
  "log_file",
  "minimal",
  "multiprocess_logging",
  "multithreading",
  "plots",
  "live_scrolling_plot",
  "raw_mesh",
]

# These are examples that we explicitly exclude from our website. You can check that all examples are either included
# or explicitly excluded by running `python scripts/check_example_manifest_coverage.py`.
[ignored]
examples = [
  "custom_collection_adapter",
  "custom_data_loader",
  "custom_space_view",
  "custom_store_subscriber",
  "extend_viewer_ui",
  "external_data_loader",
  "incremental_logging",
  "minimal_serve",
  "shared_recording",
  "spawn_viewer",
  "stdio",
  "template",
  "all_examples",
  "_empty_rerun_sdk",
]