Deprecate `SeriesLine`/`SeriesPoint`/`Scalar` in favor of `SeriesLines`/`SeriesPoints`/`Scalars` #9338

Wumpf · 2025-03-20T18:08:17Z

What

SeriesLine -> SeriesLines
SeriesPoint -> SeriesPoints
Scalar -> Scalars

The old types are still around, just deprecated.

~~There's a unit test ensuring that they still work just the same (visualizers will still activate automatically!)~~
EDIT by @emilk: the old types are migrated (renamed) during loading by re_sorbet!

The change is fairly straight forward in Python & C++. In Rust there's some ergonomic loss since arrays need to be passed more often now - in particular annoying on Scalars for single scalars. For convenience @emilk added a Scalar::one constructor for Rust.

On the flip side it's much nicer now to create columns of Scalars since with_many_scalar is no longer a thing, instead you can just create Scalar(..) with an array.

migration guide
describe what's going on here
Merge Python/CI: Raise exception on warning, e.g. call of @deprecated #9384
Update references to deprecated archetypes from doclinks in fbs files
Remove all uses to the old archetypes
Remove all references to the old names from everywhere (e.g. all docs)
Full check

github-actions · 2025-03-20T18:08:46Z

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

I have tested the web viewer

Result	Commit	Link	Manifest
✅	`ae59cdf`	https://rerun.io/viewer/pr/9338	`+nightly` `+main`

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

github-actions · 2025-03-20T18:08:50Z

Latest documentation preview deployed successfully.

Result	Commit	Link
✅	`ae59cdf`	https://landing-kf5kf1eod-rerun.vercel.app/docs

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

…ingular versions

… showcase this by now

Wumpf · 2025-03-21T10:59:35Z

docs/snippets/all/archetypes/series_lines_style.py

+rr.log("trig/sin", rr.SeriesLines(colors=[255, 0, 0], names="sin(0.01t)", widths=2), static=True)
+rr.log("trig/cos", rr.SeriesLines(colors=[0, 255, 0], names="cos(0.01t)", widths=4), static=True)


wondering whether I should put those in the same entity now for illustration 🤔
practically though separate entities make more sense here

Wumpf · 2025-03-21T11:23:15Z

@rerun-bot full-check

github-actions · 2025-03-21T11:23:44Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/13990660968

Wumpf · 2025-03-21T13:24:41Z

full check ci fails with known issue we have on main right now.

emilk · 2025-03-25T09:44:40Z

This makes me realize that the rrd backwards compatibility check should fail for deprecated archetypes/components (as they should be converted on ingestion). I added it as a TODO for myself on #9110. I'll hopefully get than done and merged before this PR, and then add a migration path to this PR :)

EDIT: Ensure we migrate deprecated types on ingestion #9370

docs/content/reference/migration/migration-0-17.md

docs/snippets/INDEX.md

crates/viewer/re_view_time_series/tests/support_for_deprecated_types.rs

emilk · 2025-03-25T10:38:57Z

crates/store/re_types/definitions/rerun/archetypes/scalar.fbs

 table Scalar (
+  "attr.rerun.deprecated": "Use `Scalars` instead.",


I think we should mandate that we include when this was deprecated ("Deprecated since Rerun 0.23").

Added to Improve how type deprecations are codegened #9371

crates/viewer/re_view_time_series/src/line_visualizer_system.rs

emilk · 2025-03-26T17:51:00Z

@rerun-bot full-check

github-actions · 2025-03-26T17:51:35Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/14090125166

emilk · 2025-03-26T17:57:31Z

@rerun-bot full-check

github-actions · 2025-03-26T17:58:03Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/14090237845

emilk · 2025-03-27T07:14:40Z

@rerun-bot full-check

github-actions · 2025-03-27T07:15:22Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/14100934943

emilk · 2025-03-27T07:30:34Z

I'm pulling out some commits into a new PR to make both pieces easier to review:

Misc improvements to codegen and testing #9395

### Related * Select commits pulled out of #9338 ### What Various improvements related to codegen, testign, and deprecation --------- Co-authored-by: Andreas Reich <[email protected]>

emilk · 2025-03-27T08:54:13Z

@rerun-bot full-check

github-actions · 2025-03-27T08:54:46Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/14102539696

emilk · 2025-03-27T09:56:12Z

@rerun-bot full-check

github-actions · 2025-03-27T09:56:43Z

Started a full build: https://github.com/rerun-io/rerun/actions/runs/14103733173

emilk · 2025-03-27T11:57:37Z

OMG IT'S GREEN I'M MERGING QUCKLY

* Introduced in #9338 `one` can be confused for `1.0`

Wumpf added include in changelog 🪵 Log & send APIs Affects the user-facing API for all languages 📈 plot Plots, charts, graphs, timeseries, … labels Mar 20, 2025

Base automatically changed from andreas/multi-scalar-points to main March 21, 2025 08:12

Wumpf changed the title ~~replace panic with proper error messages for some codegen paths~~ Deprecate SeriesLine/SeriesPoint/Scalar in favor of SeriesLines/SeriesPoints/Scalars Mar 21, 2025

Wumpf and others added 8 commits March 21, 2025 10:29

replace panic with proper error messages for some codegen paths

7d8d352

fix handling arrays of enums in codegen

1355efe

add pluralized versions of series line/points & scalar, deprecating s…

7a51c37

…ingular versions

remove experimental multi scalar demo, we have other demos & tests to…

c413849

… showcase this by now

Update examples etc ...

c2c3bd4

add test to ensure that deprecated points & lines types work

467d2c7

rust doc fix

11fd99f

python doc gen fix

e2c09b9

Wumpf force-pushed the andreas/pluralize-series-types branch from d370eb9 to e2c09b9 Compare March 21, 2025 09:30

add migration guide

db046de

Wumpf commented Mar 21, 2025

View reviewed changes

Wumpf added 2 commits March 21, 2025 12:03

more rust doc fix

36816b8

add back deprecated types to gen_common_index.py

3c40b69

Wumpf marked this pull request as ready for review March 21, 2025 11:23

emilk added this to the 0.23.0 milestone Mar 25, 2025

emilk reviewed Mar 25, 2025

View reviewed changes

docs/content/reference/migration/migration-0-17.md Outdated Show resolved Hide resolved

emilk mentioned this pull request Mar 25, 2025

Ensure we migrate deprecated types on ingestion #9370

Merged

emilk reviewed Mar 25, 2025

View reviewed changes

crates/viewer/re_view_time_series/src/line_visualizer_system.rs Outdated Show resolved Hide resolved

emilk added 3 commits March 26, 2025 18:55

codegen

92972cc

Mark new archetypes as unreleased

3dc5b60

Merge branch 'main' into andreas/pluralize-series-types

5242857

Opt-out of compare due to floating point differences

4be1e0d

emilk mentioned this pull request Mar 27, 2025

Misc improvements to codegen and testing #9395

Merged

emilk added 2 commits March 27, 2025 09:28

Merge branch 'main' into andreas/pluralize-series-types

312f3fe

Remove old reference from snippet

14bddd5

emilk added 2 commits March 27, 2025 10:29

fix opt-out

c54f726

Merge branch 'main' into andreas/pluralize-series-types

ae59cdf

emilk mentioned this pull request Mar 20, 2025

Use multi scalar in lerobot #9318

Closed

emilk approved these changes Mar 27, 2025

View reviewed changes

emilk merged commit c4eb639 into main Mar 27, 2025
80 of 81 checks passed

emilk deleted the andreas/pluralize-series-types branch March 27, 2025 11:58

This was referenced Feb 26, 2025

Migrate chunks on ingestion #9115

Open

Rename Scalars::one to Scalars::single #9436

Merged

emilk added a commit that referenced this pull request Mar 31, 2025

Rename Scalars::one to Scalars::single (#9436)

f55e447

* Introduced in #9338 `one` can be confused for `1.0`

emilk mentioned this pull request Apr 11, 2025

Release 0.23 #9588

Closed

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `SeriesLine`/`SeriesPoint`/`Scalar` in favor of `SeriesLines`/`SeriesPoints`/`Scalars` #9338

Deprecate `SeriesLine`/`SeriesPoint`/`Scalar` in favor of `SeriesLines`/`SeriesPoints`/`Scalars` #9338

Wumpf commented Mar 20, 2025 •

edited by emilk

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

Wumpf Mar 21, 2025

Wumpf commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

Wumpf commented Mar 21, 2025

emilk commented Mar 25, 2025 •

edited

Loading

emilk Mar 25, 2025 •

edited

Loading

emilk commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

emilk commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

		rr.log("trig/sin", rr.SeriesLines(colors=[255, 0, 0], names="sin(0.01t)", widths=2), static=True)
		rr.log("trig/cos", rr.SeriesLines(colors=[0, 255, 0], names="cos(0.01t)", widths=4), static=True)

		table Scalar (
		"attr.rerun.deprecated": "Use `Scalars` instead.",

Deprecate SeriesLine/SeriesPoint/Scalar in favor of SeriesLines/SeriesPoints/Scalars #9338

Deprecate SeriesLine/SeriesPoint/Scalar in favor of SeriesLines/SeriesPoints/Scalars #9338

Conversation

Wumpf commented Mar 20, 2025 • edited by emilk Loading

Related

What

github-actions bot commented Mar 20, 2025 • edited Loading

github-actions bot commented Mar 20, 2025 • edited Loading

Wumpf Mar 21, 2025

Choose a reason for hiding this comment

Wumpf commented Mar 21, 2025

github-actions bot commented Mar 21, 2025

Wumpf commented Mar 21, 2025

emilk commented Mar 25, 2025 • edited Loading

emilk Mar 25, 2025 • edited Loading

Choose a reason for hiding this comment

emilk commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

emilk commented Mar 26, 2025

github-actions bot commented Mar 26, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

github-actions bot commented Mar 27, 2025

emilk commented Mar 27, 2025

Deprecate `SeriesLine`/`SeriesPoint`/`Scalar` in favor of `SeriesLines`/`SeriesPoints`/`Scalars` #9338

Deprecate `SeriesLine`/`SeriesPoint`/`Scalar` in favor of `SeriesLines`/`SeriesPoints`/`Scalars` #9338

Wumpf commented Mar 20, 2025 •

edited by emilk

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

github-actions bot commented Mar 20, 2025 •

edited

Loading

emilk commented Mar 25, 2025 •

edited

Loading

emilk Mar 25, 2025 •

edited

Loading