SDK DataLoaders 4: working around shutdown brittleness
#5337
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teh-cmc
added
🪳 bug
Size changes
|
teh-cmc
force-pushed
the
cmc/sdk_dataloader_1_barebones_rust
branch
from
6439524
to
48498ce
Compare
This was referenced Feb 28, 2024
teh-cmc
force-pushed
the
cmc/sdk_dataloader_3_weak_recordings
branch
from
e02959c
to
f383f12
Compare
teh-cmc
force-pushed
the
cmc/sdk_dataloader_1_barebones_rust
branch
from
bcd19c1
to
bcf4aa7
Compare
teh-cmc
force-pushed
the
cmc/sdk_dataloader_3_weak_recordings
branch
from
f383f12
to
f9b951b
Compare
teh-cmc
force-pushed
the
cmc/sdk_dataloader_1_barebones_rust
branch
from
bcf4aa7
to
9e28fc9
Compare
teh-cmc
force-pushed
the
cmc/sdk_dataloader_3_weak_recordings
branch
from
f9b951b
to
1489296
Compare
8 tasks
teh-cmc
added a commit
that referenced
this pull request
Feb 29, 2024
Exposes raw `DataLoader`s to the Rust SDK through 2 new methods: `RecordingStream::log_file_from_path` & `RecordingStream::log_file_from_contents`. Everything streams asynchronously, as expected. There's no way to configure the behavior of the `DataLoader` at all, yet. That comes next. ```rust rec.log_file_from_path(filepath)?; ```  This highlighted some brittleness on the shutdown path, see: - #5335 --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337
teh-cmc
force-pushed
the
cmc/sdk_dataloader_3_weak_recordings
branch
from
1489296
to
33c9161
Compare
Wumpf
approved these changes
Feb 29, 2024
8 tasks
teh-cmc
added a commit
that referenced
this pull request
Feb 29, 2024
Exposes raw `DataLoader`s to the Python SDK through 2 new methods: `RecordingStream.log_file_from_path` & `RecordingStream.log_file_from_contents`. Everything streams asynchronously, as expected. There's no way to configure the behavior of the `DataLoader` at all, yet. That comes next. ```python rr.log_file_from_path(filepath) ```  --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355
teh-cmc
added a commit
that referenced
this pull request
Feb 29, 2024
Exposes raw `DataLoader`s to the C++ SDK through 2 new methods: `RecordingStream::log_file_from_path` & `RecordingStream::log_file_from_contents`. Everything streams asynchronously, as expected. There's no way to configure the behavior of the `DataLoader` at all, yet. That comes next. :warning: I'm carrying bytes around in a `string_view` (see `rr_bytes`) and related, and the internet has been unhelpful to tell e whether I should or shouldn't. ```cpp rec.log_file_from_path(filepath); ```  --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355 --------- Co-authored-by: Andreas Reich <[email protected]>
teh-cmc
added a commit
that referenced
this pull request
Feb 29, 2024
Adds new `RecommendedLoadSettings` that gets passed to all `DataLoader`s -- builtin and external -- in order to customize their behaviors. This includes: - A recommended recording ID - The ID of the currently opened recording in the viewer (not implemented) - Related: #5350 - A recommended entity path prefix - A recommended timepoint ```bash cargo r -p rerun-loader-rust-file -- run_wasm/src/main.rs --recording-id this-one --entity-path-prefix a/b/c --time sim_time=1000 --time wall_time=1709204046 --sequence sim_frame=42 | rerun - ```  Checks: - [x] external loader ran manually (`loader | rerun`) - [x] external loader via rerun (`rerun xxx.rs`) - [x] log_file with external loader (`log_file xxx.rs`) --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355
8 tasks
teh-cmc
added a commit
that referenced
this pull request
Mar 1, 2024
Introduces the new `DataLoaderSettings` business to Python and update examples accordingly (`external_data_loader` & `log_file`). ```bash python examples/python/external_data_loader/main.py --recording-id this-one --entity-path-prefix a/b/c --time sim_time=1000 --time wall_time=1709204046 --sequence sim_frame=42 examples/python/dna/main.py | rerun - ```  Checks: - [x] external loader ran manually (`python loader | rerun`) - [x] external loader via rerun (`rerun xxx.py`) - [x] log_file with external loader (`log_file xxx.py`) --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355 - #5361
This was referenced Mar 4, 2024
teh-cmc
added a commit
that referenced
this pull request
Mar 4, 2024
This makes the `log_file` APIs behave more like the standard `log` APIs; i.e. they inherit the state of their associated `RecordingStream` (app_id, rec_id, timepoint, etc...). Also inherit the application ID while we're at it. Makes the API much nicer to use _and_ much more consistent with the rest. Checks: - [x] external loader ran manually (`python loader | rerun`) - [x] external loader via rerun (`rerun xxx.py`) - [x] log_file with external loader (`log_file xxx.py`) - [x] external loader ran manually (`loader | rerun`) - [x] external loader via rerun (`rerun xxx.rs`) - [x] log_file with external loader (`log_file xxx.rs`) --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355 - #5379 - #5361 - #5388 --------- Co-authored-by: Andreas Reich <[email protected]>
teh-cmc
added a commit
that referenced
this pull request
Mar 4, 2024
Introduces the new `DataLoaderSettings` business to C++ and update examples accordingly (`external_data_loader` & `log_file`). ```bash ./build/debug/examples/cpp/log_file/example_log_file --recording-id this-one --entity-path-prefix a/b/c --time sim_time=1000 --time wall_time=1709204046 --sequence sim_frame=42 rerun_cpp/tests/main.cpp | rerun - ```  Checks: - [x] external loader ran manually (`loader.exe | rerun`) - [x] external loader via rerun (`rerun xxx.cpp`) - [x] log_file with external loader (`log_file xxx.cpp`) --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355 - #5379 - #5361 - #5388
teh-cmc
added a commit
that referenced
this pull request
Mar 6, 2024
I guess that's good enough 🤷. I don't know, my brain has been completely friend by C++ non-sense all day. This includes a fix to make sure that a viewer that was spawned from the python SDK is still allowed to spawn dataloaders implemented in python (`RERUN_APP_ONLY` shenaniganeries). - Fixes #4526 --- Part of series of PR to expose configurable `DataLoader`s to our SDKs: - #5327 - #5328 - #5330 - #5337 - #5351 - #5355 - #5379 - #5361 - #5388
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces
RecordingStream::clone_weak, soDataLoaderthreads started from the SDK don't prevent the recording from flushing oncemaingoes out of scope, all the while making sure thatDataLoaders run to completion.RecordingStream's brittle shutdown/flush behavior #5335Part of series of PR to expose configurable
DataLoaders to our SDKs:DataLoaders 1: barebones Rust support #5327DataLoaders 2: barebones Python support #5328DataLoaders 3: barebones C and C++ support #5330DataLoaders 4: working around shutdown brittleness #5337DataLoaders 5: customizable (external) loaders for Rust #5351DataLoaders 6: customizable (external) loaders for Python #5355DataLoaders 7: stateful file logging #5379DataLoaders 8: customizable (external) loaders for C++ #5361Checklist
mainbuild: app.rerun.ionightlybuild: app.rerun.io