Archetype based overrides & defaults

[Wumpf]

Related

• Fixes Archetype based override/default logging #9059

What

Defaults and overrides can now be set using archetypes. This not only leads to a much more ergonomic API with working auto-complete for archetype fields, but also paves the way for handling tagging in blueprint overrides/defaults which in the future will allow more fine grained defaults/overrides using the archetype "context information".

Examples

Setting default & override for radius

Before:

rrb.Spatial2DView(
    name="Rect 1",
    origin="/",
    contents=["/**"],
    defaults=[rr.components.Radius(2)],
    overrides={"rect/0": [rr.components.Radius(1)]},
)

After:

rrb.Spatial2DView(
    name="Rect 1",
    origin="/",
    contents=["/**"],
    defaults=[rr.Boxes2D.from_fields(radii=1)],
    overrides={"rect/0": rr.Boxes2D.from_fields(radii=2)},
)

Setting up styles for a plot.

Before:

rrb.TimeSeriesView(
    name="Trig",
    origin="/trig",
    overrides={
        "/trig/sin": [rr.components.Color([255, 0, 0]), rr.components.Name("sin(0.01t)")],
        "/trig/cos": [rr.components.Color([0, 255, 0]), rr.components.Name("cos(0.01t)")],
    },
),
rrb.TimeSeriesView(
    name="Classification",
    origin="/classification",
    overrides={
        "classification/line": [rr.components.Color([255, 255, 0]), rr.components.StrokeWidth(3.0)],
        "classification/samples": [rrb.VisualizerOverrides("SeriesPoint")], # This ensures that the `SeriesPoint` visualizers is used for this entity.
    },
),

After:

rrb.TimeSeriesView(
    name="Trig",
    origin="/trig",
    overrides={
        "/trig/sin": rr.SeriesLine.from_fields(color=[255, 0, 0], name="sin(0.01t)"),
        "/trig/cos": rr.SeriesLine.from_fields(color=[0, 255, 0], name="cos(0.01t)"),
    },
),
rrb.TimeSeriesView(
    name="Classification",
    origin="/classification",
    overrides={
        "classification/line": rr.SeriesLine.from_fields(color=[255, 255, 0], width=3.0),
        "classification/samples": rrb.VisualizerOverrides("SeriesPoint"), # This ensures that the `SeriesPoint` visualizers is used for this entity.
    },
),

---

Technical notes on corner cases

There's two special cases that were loose component so far:

• VisualizerOverrides
  • the former component becomes an archetype with a list of VisualizerOverride components each being a rerun.datatypes.Utf8. rerun.datatypes.Utf8List which was previously used goes away
• VisualTimeRange
  • we already have an archetype for this, it's called VisualTimeRanges. There's a bit of an ergonomic issue with this since VisualTimeRanges has to be constructed from one or more VisualTimeRange. But decided to enforce the archetype here. To avoid accidentally using the component instead of the datatype with the same name, I moved the component out and the datatype in to the rrb namespace

---

• go through override/default docs & associated snippets

[github-actions]

Web viewer built successfully. If applicable, you should also test it:

• I have tested the web viewer

Result	Commit	Link	Manifest
✅	ce585be	https://rerun.io/viewer/pr/9209	+nightly +main

^{Note: This comment is updated whenever you push a commit.}

[github-actions]

Latest documentation preview deployed successfully.

Result	Commit	Link
✅	ce585be	https://landing-o1ka242ud-rerun.vercel.app/docs

^{Note: This comment is updated whenever you push a commit.}

[Wumpf]

back to draft: Really unhappy with how I handled VisualTimeRange. It's mega confusing imho

(Edit: Fixed, see updated description)

[abey79]

Great stuff!