Add columnar APIs to the Python docs #7183
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
emilk
added a commit
that referenced
this pull request
Aug 16, 2024
TODO: - [x] This branch removes `examples-ocr` because it broke CI build -- make sure to revert that - [ ] This branch adds `binaryen` to `wheel-test` -- make sure to revert that (?) - [x] handle link todos before putting up release notes - [x] include #7184 - [x] include #7183 - [x] include #7185 ### 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 `main`_, 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 `Set as latest release`, then click `Publish release`. - [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, `regro-cf-autotick-bot` will create a [conda feedstock PR](https://github.com/conda-forge/rerun-sdk-feedstock/pulls). Make sure Jeremy is on top of it! ### 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/7146?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/7146?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/7146) - [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: rerun-bot <[email protected]> Co-authored-by: Andreas Reich <[email protected]> Co-authored-by: Antoine Beyeler <[email protected]> Co-authored-by: Emil Ernerfeldt <[email protected]> Co-authored-by: Jan Procházka <[email protected]> Co-authored-by: jprochazk <[email protected]> Co-authored-by: Antoine Beyeler <[email protected]>
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
This PR adds the columnar API to the python docs.
I had to rename the
send_columns.pyfile to_send_columns.py, because:rerun.send_columnsis ambiguous (is that the submodule or the function that__init__.pyre-exports?rerunnamespace) should be named as private (leading_)Also added/modified a few docstrings to make the docs nicer.
Edit:
ComponentColumnand add it to the index for the build to pass.Checklist
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.