Dataframe v2: reference docs #7820
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
teh-cmc
added
📖 documentation
Deployed docs
|
teh-cmc
commented
Oct 17, 2024
teh-cmc
commented
Oct 17, 2024
docs/content/reference/dataframes.md
Outdated
|
|
||
| Check out the API reference to learn more about all the ways that data can be searched and filtered: | ||
| * [🐍 Python API reference](https://ref.rerun.io/docs/python/stable/common/dataframe/) | ||
| * [🐍 Python example](https://github.com/rerun-io/rerun/blob/124be04fb1a5695d50813860903f575010bf5bc7/examples/python/dataframe_query/dataframe_query.py) |
There was a problem hiding this comment.
properly version link incoming when #7817 is merged
teh-cmc
commented
Oct 17, 2024
docs/content/reference/dataframes.md
Outdated
| * [🐍 Python API reference](https://ref.rerun.io/docs/python/stable/common/dataframe/) | ||
| * [🐍 Python example](https://github.com/rerun-io/rerun/blob/124be04fb1a5695d50813860903f575010bf5bc7/examples/python/dataframe_query/dataframe_query.py) | ||
| * [🦀 Rust API reference](https://docs.rs/crate/rerun/latest) | ||
| * [🦀 Rust example](https://github.com/rerun-io/rerun/blob/124be04fb1a5695d50813860903f575010bf5bc7/examples/rust/dataframe_query/src/main.rs) |
There was a problem hiding this comment.
properly version link incoming when #7817 is merged
teh-cmc
force-pushed
the
cmc/dataframe_docs
branch
from
f411bef
to
b8778bf
Compare
zehiko
approved these changes
Oct 18, 2024
teh-cmc
force-pushed
the
cmc/dataframe_examples
branch
from
87ed4ad
to
c036272
Compare
teh-cmc
force-pushed
the
cmc/dataframe_docs
branch
from
b8778bf
to
1d922f9
Compare
teh-cmc
added a commit
that referenced
this pull request
Oct 19, 2024
commit 0033e78 Author: Clement Rey <[email protected]> Date: Sat Oct 19 18:12:39 2024 +0200 Mimalloc 0.1.43+ (#7713) * Includes fix for purpleprotocol/mimalloc_rust#128 * Potentially includes fix for #5875 commit d0ee720 Author: Clement Rey <[email protected]> Date: Sat Oct 19 18:07:38 2024 +0200 Dataframe v2: reference docs (#7820) Add a reference page for the dataframe APIs. It's still very barebones at this point because #7819 makes it very difficult to write snippets for this. But it is literally infinitely better than what's there right now: nothing. - DNM: requires #7817 - Closes #7828 commit c00a9f6 Author: Andreas Reich <[email protected]> Date: Sat Oct 19 17:59:15 2024 +0200 Fix Rust dna sample writing to a temporary file (#7827) commit 31d5943 Author: Clement Rey <[email protected]> Date: Sat Oct 19 17:58:48 2024 +0200 Dataframe v2: examples (#7817) Full standalone Rust & Python examples for people who like to learn by jumping straight into the examples/ folder. Simpler snippets and the associated reference page are coming in a future PR. commit 6d86699 Author: Kevin Reid <[email protected]> Date: Sat Oct 19 08:52:31 2024 -0700 Update "Migration Guides" redirect to point to 0.19. (#7837) Update "Migration Guides" redirect to point to 0.19, so visitors see the 0.19 guide first instead of the 0.18 guide. commit 5b66659 Author: Jeremy Leibs <[email protected]> Date: Fri Oct 18 13:34:25 2024 -0400 Remove py-tasks feature from py-docs env (#7835) ### What Fixes task ambiguity on the `py-build` task: ``` ➜ pixi run py-build ? The task 'py-build' can be run in multiple environments. Please select an environment to run the task in: › ❯ py py-docs ``` ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7835?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7835?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! * [x] If have noted any breaking changes to the log API in `CHANGELOG.md` and the migration guide - [PR Build Summary](https://build.rerun.io/pr/7835) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`. commit e568694 Author: rerun-bot <[email protected]> Date: Fri Oct 18 16:24:55 2024 +0200 Release 0.19.0 (#7799) ### Next steps - Test the release - If this is an 'alpha' release, you can just merge the pull request. - Otherwise: - For any added commits, run the release workflow in 'rc' mode again - After testing, _ensure that this PR is mergeable to _, then run the release workflow in 'release' mode - Once the final release workflow finishes it will create a GitHub release for you. Then: - [x] Sanity check the build artifacts: - [x] pip install: does it install and run? - [x] cargo install of cli tool: does it install and run? - [x] C++ SDK zip: does it contain rerun_c for all platforms? - [x] Populate the release with the changelog and a nice header video/picture, check , then click . - [x] Update the [google colab notebooks](https://drive.google.com/drive/folders/0AC0q24MFKh3fUk9PVA) to install this version and re-execute the notebook. A few hours after the GitHub release is created, will create a [conda feedstock PR](https://github.com/conda-forge/rerun-sdk-feedstock/pulls). Make sure Jeremy is on top of it! - [x] Tests - [x] Windows - [x] Linux - [x] MacOS --------- Co-authored-by: Jeremy Leibs <[email protected]> Co-authored-by: Emil Ernerfeldt <[email protected]> Co-authored-by: Clement Rey <[email protected]> commit fb3980b Author: Jeremy Leibs <[email protected]> Date: Fri Oct 18 07:33:15 2024 -0400 Mike depends on setuptools (#7829) ### What Fixes regression from #7818 ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7829?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7829?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! * [x] If have noted any breaking changes to the log API in `CHANGELOG.md` and the migration guide - [PR Build Summary](https://build.rerun.io/pr/7829) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`. commit 1cc6244 Author: Gijs de Jong <[email protected]> Date: Fri Oct 18 13:28:20 2024 +0200 Allow logging individual components directly (Impl `AsComponents` for all `ObjectKind::Component`) (#7756) <!-- Open the PR up as a draft until you feel it is ready for a proper review. Do not make PR:s from your own `main` branch, as that makes it difficult for reviewers to add their own fixes. Add any improvements to the branch as new commits to make it easier for reviewers to follow the progress. All commits will be squashed to a single commit once the PR is merged into `main`. Make sure you mention any issues that this PR closes in the description, as well as any other related issues. To get an auto-generated PR description you can put "copilot:summary" or "copilot:walkthrough" anywhere. --> ### What This implements `AsComponents` for all `Component`s, which makes the rust api slightly more ergonomic and makes this possible: ```rs rec.log_static("my_points", &rerun::Color::from_rgb(128, 128, 128))?; ``` ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7756?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7756?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! * [x] If have noted any breaking changes to the log API in `CHANGELOG.md` and the migration guide - [PR Build Summary](https://build.rerun.io/pr/7756) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`. --------- Co-authored-by: Andreas Reich <[email protected]> commit 9773d8a Author: Andreas Reich <[email protected]> Date: Fri Oct 18 12:09:11 2024 +0200 Clarify viewport documentation and reference the type list for view classes (#7826) ### What * Fixes #3039 ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) - [PR Build Summary](https://build.rerun.io/pr/7826) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`. commit 587cfce Author: Jeremy Leibs <[email protected]> Date: Fri Oct 18 04:34:37 2024 -0400 Bring back the `py-docs` pixi environment (#7818) ### What - Resolves: #6060 Pip installing things into pixi environments is always a recipe for pain. This is the way. Pushed this branch to `docs-latest` and confirmed it succeeded: - https://github.com/rerun-io/rerun/actions/runs/11390203895 ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7818?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/7818?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG * [x] If applicable, add a new check to the [release checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! * [x] If have noted any breaking changes to the log API in `CHANGELOG.md` and the migration guide - [PR Build Summary](https://build.rerun.io/pr/7818) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`.
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.
Add a reference page for the dataframe APIs.
It's still very barebones at this point because #7819 makes it very difficult to write snippets for this.
But it is literally infinitely better than what's there right now: nothing.