Skip to content

Add columnar APIs to the Python docs#7183

Merged
abey79 merged 3 commits intomainfrom
antoine/columnar-api-py-docs
Aug 14, 2024
Merged

Add columnar APIs to the Python docs#7183
abey79 merged 3 commits intomainfrom
antoine/columnar-api-py-docs

Conversation

@abey79
Copy link
Copy Markdown
Member

@abey79 abey79 commented Aug 14, 2024

What

This PR adds the columnar API to the python docs.

I had to rename the send_columns.py file to _send_columns.py, because:

  • rerun.send_columns is ambiguous (is that the submodule or the function that __init__.py re-exports?
  • mkdocs is thus confused
  • all such module (aka whose content is reexported in the top rerun namespace) should be named as private (leading _)

Also added/modified a few docstrings to make the docs nicer.

Edit:

  • also had to reexport ComponentColumn and add it to the index for the build to pass.
image

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@abey79 abey79 added 📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md labels Aug 14, 2024
Copy link
Copy Markdown
Contributor

@teh-cmc teh-cmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based

@teh-cmc teh-cmc mentioned this pull request Aug 14, 2024
18 tasks
@abey79 abey79 merged commit 94886ea into main Aug 14, 2024
@abey79 abey79 deleted the antoine/columnar-api-py-docs branch August 14, 2024 14:24
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 <bot@rerun.io>
Co-authored-by: Andreas Reich <andreas@rerun.io>
Co-authored-by: Antoine Beyeler <49431240+abey79@users.noreply.github.com>
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Co-authored-by: Jan Procházka <honza.spacir@gmail.com>
Co-authored-by: jprochazk <1665677+jprochazk@users.noreply.github.com>
Co-authored-by: Antoine Beyeler <antoine@rerun.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants