Migrating from 0.22 to 0.23

Timelines are uniquely identified by name timelines-are-uniquely-identified-by-name

Previously, you could (confusingly) have two timelines with the same name, as long as they had different types (sequence vs temporal). This is no longer possible. Timelines are now uniquely identified by name, and if you use different types on the same timeline, you will get a logged warning, and the latest type will be used to interpret the full set of time data.

Rename some timeline-related things as "index" rename-some-timelinerelated-things-as-index

We're planning on adding support for different types of indices in the future, so to that point we're slowly migrating our API to refer to these things as indices rather than timelines.

Differentiate between timestamps and durations differentiate-between-timestamps-and-durations

We've added a explicit API for setting time, where you need to explicitly specify if a time is either a timestamp (e.g. 2025-03-03T14:34:56.123456789) or a duration (e.g. 123s).

Before, Rerun would try to guess what you meant (small values were assumed to be durations, and large values were assumes to be durations since the Unix epoch, i.e. timestamps). Now you need to be explicit.

🦀 Rust: deprecated `RecordingStream::set_time_seconds` and `set_time_nanos` -rust-deprecated-recordingstreamsettimeseconds-and-settimenanos

Use one of these instead:

set_duration_seconds
set_timestamp_seconds_since_epoch
set_index with std::time::Duration
set_index with std::time::SystemTime

🌊 C++: replaced `RecordingStream::set_time_` with `set_index_` -c-replaced-recordingstreamsettime-with-setindex

We've deprecated the following functions, with the following replacements:

set_time_sequence -> set_index_sequence
set_time -> set_index_duration or set_index_timestamp
set_time_seconds -> set_index_duration_secs or set_index_timestamp_seconds_since_epoch
set_time_nanos -> set_index_duration_nanos or set_index_timestamp_nanos_since_epoch

TimeColumn also has deprecated functions.

🐍 Python: replaced `rr.set_time_*` with `rr.set_index` -python-replaced-rrsettime-with-rrsetindex

We're moving towards a more explicit API for setting time, where you need to explicitly specify if a time is either a datetime (e.g. 2025-03-03T14:34:56.123456789) or a timedelta (e.g. 123s).

Previously we would infer the user intent at runtime based on the value: if it was large enough, it was interpreted as time since the Unix epoch, otherwise it was interpreted as a timedelta.

To this end, we're deprecated rr.set_time_seconds, rr.set_time_nanos, as well as rr.set_time_sequence and replaced them with rr.set_index. set_index takes either a sequence=, timedelta= or datetime= argument.

timedelta must be either:

seconds as int or float
datetime.timedelta
numpy.timedelta64

datetime must be either:

seconds since unix epoch (1970-01-01) as int or float
datetime.datetime
numpy.datetime64

Migrating

`rr.set_sequence("foo", 42)`

New: rr.set_index("foo", sequence=42)

`rr.set_time_seconds("foo", duration_seconds)`

When using relative times (durations/timedeltas): rr.set_index("foo", timedelta=duration_seconds) You can also pass in a datetime.timedelta or numpy.timedelta64 directly.

`rr.set_time_seconds("foo", seconds_since_epoch)`

New: rr.set_index("foo", datetime=seconds_since_epoch) You can also pass in a datetime.datetime or numpy.datetime64 directly.

`rr.set_time_nanos("foo", duration_nanos)`

Either:

rr.set_index("foo", timedelta=1e-9 * duration_nanos)
rr.set_index("foo", timedelta=np.timedelta64(duration_nanos, 'ns'))

The former is subject to (double-precision) floating point precision loss (but still nanosecond precision for timedeltas below less than 100 days in duration), while the latter is lossless.

`rr.set_time_nanos("foo", nanos_since_epoch)`

Either:

rr.set_index("foo", datetime=1e-9 * nanos_since_epoch)
rr.set_index("foo", datetime=np.datetime64(nanos_since_epoch, 'ns'))

The former is subject to (double-precision) floating point precision loss (still microsecond precision for the next century), while the latter is lossless.

🐍 Python: replaced `rr.Time*Column` with `rr.IndexColumn` -python-replaced-rrtimecolumn-with-rrindexcolumn

Similarly to the above new set_index API, there is also a new IndexColumn class that replaces TimeSequenceColumn, TimeSecondsColumn, and TimeNanosColumn. The migration is very similar to the above.

Migration

`rr.TimeSequenceColumn("foo", values)`

New: rr.IndexColumn("foo", sequence=values)

`rr.TimeSecondsColumn("foo", duration_seconds)`

New: rr.IndexColumn("foo", timedelta=duration_seconds)

`rr.TimeSecondsColumn("foo", seconds_since_epoch)`

New: rr.IndexColumn("foo", datetime=seconds_since_epoch)

`rr.TimeNanosColumn("foo", duration_nanos)`

Either:

rr.IndexColumn("foo", timedelta=1e-9 * duration_nanos)
rr.IndexColumn("foo", timedelta=np.timedelta64(duration_nanos, 'ns'))

The former is subject to (double-precision) floating point precision loss (but still nanosecond precision for timedeltas below less than 100 days in duration), while the latter is lossless.

`rr.TimeNanosColumn("foo", nanos_since_epoch)`

Either:

rr.IndexColumn("foo", timedelta=1e-9 * nanos_since_epoch)
rr.IndexColumn("foo", timedelta=np.timedelta64(nanos_since_epoch, 'ns'))

The former is subject to (double-precision) floating point precision loss (still microsecond precision for the next century), while the latter is lossless.

🐍 Python: `rr.new_recording` is now deprecated in favor of `rr.RecordingStream` -python-rrnewrecording-is-now-deprecated-in-favor-of-rrrecordingstream

Previously, RecordingStream instances could be created with the rr.new_recording() function. This method is now deprecated in favor of directly using the RecordingStream constructor. The RecordingStream constructor is mostly backward compatible, so in most case it is matter of using RecordingStream instead of new_recording:

# before
rec = rr. new_recording("rerun_example")

# after
rec = rr.RecordingStream("my_app_id")

If you used the spawn=True argument, you will now have to call the spawn() method explicitly:

# before
rec = rr. new_recording("my_app_id", spawn=True)

# after
rec = rr.RecordingStream("my_app_id")
rec.spawn()

🐍 Python: removed `rr.log_components()`, `rr.connect()`, `rr.connect_tcp()`, and `rr.serve()` -python-removed-rrlogcomponents-rrconnect-rrconnecttcp-and-rrserve

These functions were deprecated in 0.22 and are no longer available.

Calls to rr.log_components() API are now superseded by the new partial update API. See the documentation and the migration instructions.

Calls to rr.connect() and rr.connect_tcp() must be changed to rr.connect_grpc().

Calls to rr.serve() must be changed to rr.serve_web().

🌊 C++: removed `connect` and `connect_tcp` from `RecordingStream` -c-removed-connect-and-connecttcp-from-recordingstream

Calls to these functions must be changed to connect_grpc. Note that the string passed to connect_grpc must now be a valid Rerun URL. If you were previously calling connect_grpc("127.0.0.1:9876"), it must be changed to connect_grpc("rerun+http://127.0.0.1:9876/proxy").

See the RecordingStream docs for more information.

🦀 Rust: removed `connect` and `connect_tcp` from `RecordingStream` and `RecordingStreamBuilder` -rust-removed-connect-and-connecttcp-from-recordingstream-and-recordingstreambuilder

Calls to these functions must be changed to use connect_grpc instead.

Note that the string passed to connect_grpc must now be a valid Rerun URL. If you were previously calling connect("127.0.0.1:9876"), it must be changed to connect_grpc("rerun+http://127.0.0.1:9876/proxy").

The following schemes are supported: rerun+http://, rerun+https:// and rerun://, which is an alias for rerun+https://. These schemes are then converted on the fly to either http:// or https://. Rerun uses gRPC-based protocols under the hood, which means that the paths (/catalog, /recording/12345, …) are mapped to gRPC services and methods on the fly.

🐍 Python: blueprint overrides & defaults are now archetype based -python-blueprint-overrides--defaults-are-now-archetype-based

Just like with send_columns in the previous release, blueprint overrides and defaults are now archetype based.

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.
    },
),
# …

⚠️ Warning: Just like regular log/send calls, overlapping component types still overwrite each other. E.g. overriding a box radius will also override point radius on the same entity. In a future release, components tagged with a different archetype or field name can live side by side, but for the moment the Viewer is not able to make this distinction. For details see #6889.

Visible time range overrides have to specify the underlying archetype visible-time-range-overrides-have-to-specify-the-underlying-archetype

(Note that this functionality broken in at least Rerun 0.21 and 0.22 but is fixed now. See #8557)

Before:

# …
overrides={
    "helix/structure/scaffolding/beads": [
        rrb.VisibleTimeRange(
            "stable_time",
            start=rrb.TimeRangeBoundary.cursor_relative(seconds=-0.3),
            end=rrb.TimeRangeBoundary.cursor_relative(seconds=0.3),
        ),
    ],
},
# …

After:

# …
overrides={
    "helix/structure/scaffolding/beads": rrb.VisibleTimeRanges(
            timeline="stable_time",
            start=rrb.TimeRangeBoundary.cursor_relative(seconds=-0.3),
            end=rrb.TimeRangeBoundary.cursor_relative(seconds=0.3)
        ),
}
# …

… or respectively for multiple timelines:

# …
overrides={
    "helix/structure/scaffolding/beads": rrb.VisibleTimeRanges([
        rrb.VisibleTimeRange(
            timeline="stable_time",
            start=rrb.TimeRangeBoundary.cursor_relative(seconds=-0.3),
            end=rrb.TimeRangeBoundary.cursor_relative(seconds=0.3)
        ),
        rrb.VisibleTimeRange(
            timeline="index",
            start=rrb.TimeRangeBoundary.absolute(seq=10),
            end=rrb.TimeRangeBoundary.absolute(seq=100)
        ),
    ])
}
# …

Rerun

Migrating from 0.22 to 0.23

Timelines are uniquely identified by name timelines-are-uniquely-identified-by-name

Rename some timeline-related things as "index" rename-some-timelinerelated-things-as-index

Differentiate between timestamps and durations differentiate-between-timestamps-and-durations

🦀 Rust: deprecated RecordingStream::set_time_seconds and set_time_nanos -rust-deprecated-recordingstreamsettimeseconds-and-settimenanos

🌊 C++: replaced RecordingStream::set_time_* with set_index_* -c-replaced-recordingstreamsettime-with-setindex

🐍 Python: replaced rr.set_time_* with rr.set_index -python-replaced-rrsettime-with-rrsetindex

Migrating

rr.set_sequence("foo", 42)

rr.set_time_seconds("foo", duration_seconds)

rr.set_time_seconds("foo", seconds_since_epoch)

rr.set_time_nanos("foo", duration_nanos)

rr.set_time_nanos("foo", nanos_since_epoch)

🐍 Python: replaced rr.Time*Column with rr.IndexColumn -python-replaced-rrtimecolumn-with-rrindexcolumn

Migration

rr.TimeSequenceColumn("foo", values)

rr.TimeSecondsColumn("foo", duration_seconds)

rr.TimeSecondsColumn("foo", seconds_since_epoch)

rr.TimeNanosColumn("foo", duration_nanos)

rr.TimeNanosColumn("foo", nanos_since_epoch)

🐍 Python: rr.new_recording is now deprecated in favor of rr.RecordingStream -python-rrnewrecording-is-now-deprecated-in-favor-of-rrrecordingstream

🐍 Python: removed rr.log_components(), rr.connect(), rr.connect_tcp(), and rr.serve() -python-removed-rrlogcomponents-rrconnect-rrconnecttcp-and-rrserve

🌊 C++: removed connect and connect_tcp from RecordingStream -c-removed-connect-and-connecttcp-from-recordingstream

🦀 Rust: removed connect and connect_tcp from RecordingStream and RecordingStreamBuilder -rust-removed-connect-and-connecttcp-from-recordingstream-and-recordingstreambuilder

🐍 Python: blueprint overrides & defaults are now archetype based -python-blueprint-overrides--defaults-are-now-archetype-based

Visible time range overrides have to specify the underlying archetype visible-time-range-overrides-have-to-specify-the-underlying-archetype

🦀 Rust: deprecated `RecordingStream::set_time_seconds` and `set_time_nanos` -rust-deprecated-recordingstreamsettimeseconds-and-settimenanos

🌊 C++: replaced `RecordingStream::set_time_` with `set_index_` -c-replaced-recordingstreamsettime-with-setindex

🐍 Python: replaced `rr.set_time_*` with `rr.set_index` -python-replaced-rrsettime-with-rrsetindex

`rr.set_sequence("foo", 42)`

`rr.set_time_seconds("foo", duration_seconds)`

`rr.set_time_seconds("foo", seconds_since_epoch)`

`rr.set_time_nanos("foo", duration_nanos)`

`rr.set_time_nanos("foo", nanos_since_epoch)`

🐍 Python: replaced `rr.Time*Column` with `rr.IndexColumn` -python-replaced-rrtimecolumn-with-rrindexcolumn

`rr.TimeSequenceColumn("foo", values)`

`rr.TimeSecondsColumn("foo", duration_seconds)`

`rr.TimeSecondsColumn("foo", seconds_since_epoch)`

`rr.TimeNanosColumn("foo", duration_nanos)`

`rr.TimeNanosColumn("foo", nanos_since_epoch)`

🐍 Python: `rr.new_recording` is now deprecated in favor of `rr.RecordingStream` -python-rrnewrecording-is-now-deprecated-in-favor-of-rrrecordingstream

🐍 Python: removed `rr.log_components()`, `rr.connect()`, `rr.connect_tcp()`, and `rr.serve()` -python-removed-rrlogcomponents-rrconnect-rrconnecttcp-and-rrserve

🌊 C++: removed `connect` and `connect_tcp` from `RecordingStream` -c-removed-connect-and-connecttcp-from-recordingstream

🦀 Rust: removed `connect` and `connect_tcp` from `RecordingStream` and `RecordingStreamBuilder` -rust-removed-connect-and-connecttcp-from-recordingstream-and-recordingstreambuilder