Add a "Getting started" guide for the dataframe API #7643
Merged
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
abey79
added
📖 documentation
Deployed docs
|
abey79
force-pushed
the
antoine/data-out-tutorial
branch
3 times, most recently
from
6e0cc8b
to
02d3921
Compare
12 tasks
abey79
force-pushed
the
antoine/data-out-tutorial
branch
from
02d3921
to
affd8f8
Compare
abey79
changed the base branch from
main
to
antoine/rename-filter-is-not-null
abey79
changed the title
abey79
added
feat-dataframe-view
abey79
force-pushed
the
antoine/data-out-tutorial
branch
from
affd8f8
to
f461798
Compare
abey79
changed the base branch from
antoine/rename-filter-is-not-null
to
antoine/nolint-blocks
abey79
force-pushed
the
antoine/nolint-blocks
branch
from
a8e7c63
to
085c1d8
Compare
abey79
force-pushed
the
antoine/data-out-tutorial
branch
3 times, most recently
from
5fe26ad
to
fe0255c
Compare
Wumpf
force-pushed
the
antoine/data-out-tutorial
branch
from
fe0255c
to
603e4c6
Compare
Wumpf
reviewed
Oct 15, 2024
|
It would be nice to have these below each other |
Wumpf
reviewed
Oct 16, 2024
| </picture> | ||
|
|
||
| Here is how this view is configured: | ||
| - Its content is set to `/blendshapes/0/jawOpen`. As a result, the table only contains columns pertaining to that entity (along with any timeline(s)). For this entity, a single column exists in the table, corresponding to entity's single component (a `Scalar`). |
There was a problem hiding this comment.
we call it entity path filter right now. Saying content here makes it hard to find in the ui
| - The `frame_nr` timeline is used as index for the table. This means that the table will contain one row for each distinct value of `frame_nr` for which data is available. | ||
| - The rows can further be filtered by time range. In this case, we keep the default "infinite" boundaries, so no filtering is applied. | ||
| - The dataframe view has other advanced features which we are not using here, including filtering rows based on the existence of data for a given column, or filling empty cells with latest-at data. | ||
|
|
There was a problem hiding this comment.
embedding code here for the blueprint would be amazing 💭
| - The last columns is named `/blendshapes/0/jawOpen:Scalar`. This is what we call a _component column_, and it corresponds to the [Scalar](../../reference/types/components/scalar.md) component logged to the `/blendshapes/0/jawOpen` entity. | ||
| - Each row in the `/blendshapes/0/jawOpen:Scalar` column consists of a _list_ of (typically one) scalar. | ||
|
|
||
| This last point may come as a surprise but is a consequence of Rerun's data model where components are always stored as arrays. This enables, for example, to log an entire point cloud using the [`Points3D`](../../reference/types/archetypes/points3d.md) archetype under a single entity and at a single timestamp. |
There was a problem hiding this comment.
excellent clarification at just the right moment
Co-authored-by: Andreas Reich <[email protected]>
Co-authored-by: Andreas Reich <[email protected]>
Co-authored-by: Andreas Reich <[email protected]>
Co-authored-by: Andreas Reich <[email protected]>
Co-authored-by: Andreas Reich <[email protected]>
zehiko
approved these changes
Oct 16, 2024
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.
What
WIP getting started guide. A skeleton with some working code for now. Very much in need of feedback.
may need this to pass CI:
lint.py#7720Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerCHANGELOG.mdand the migration guideTo run all checks from
main, comment on the PR with@rerun-bot full-check.