Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New notebook API #6573

Merged
merged 37 commits into from
Jun 24, 2024
Merged

New notebook API #6573

merged 37 commits into from
Jun 24, 2024

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Jun 14, 2024 •
edited
Loading

What

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!

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

@jprochazk jprochazk added 🕸️ web regarding running the viewer in a browser notebook Jupyter notebooks etc include in changelog labels Jun 14, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 14, 2024 •
edited
Loading

Deployed docs

Commit Link
899d1e0 https://landing-l9uc8asyv-rerun.vercel.app/docs

@jprochazk jprochazk marked this pull request as ready for review June 20, 2024 11:07
jleibs
jleibs approved these changes Jun 21, 2024
View reviewed changes
Copy link
Member

@jleibs jleibs left a comment

Choose a reason for hiding this comment

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

Awesome work!

.github/workflows/reusable_checks_python.yml Outdated Show resolved Hide resolved
rerun_py/rerun_sdk/rerun/notebook.py Outdated Show resolved Hide resolved
rerun_py/rerun_sdk/rerun/blueprint/api.py Show resolved Hide resolved
examples/python/notebook/cube.ipynb Outdated Show resolved Hide resolved
@jleibs jleibs mentioned this pull request Jun 21, 2024
Closed
@jprochazk jprochazk mentioned this pull request Jun 24, 2024
Open
@jprochazk jprochazk merged commit 0ac1707 into main Jun 24, 2024
41 checks passed
@jprochazk jprochazk deleted the jan/new-notebook-api branch June 24, 2024 09:08
@nikolausWest
Copy link
Member

It feels like this feature should require some extended / updated documentation but I didn't see it (from a glance) on this PR. @jprochazk: is that done / something you've considered?

@jprochazk
Copy link
Member Author

jprochazk commented Jun 24, 2024 •
edited
Loading

@nikolausWest All the new APIs have doc comments (rr.notebook.Viewer in python, CallbackSink in rust), and the only major breaking change here is that data is consumed when you display it in a notebook: #6573 (comment). Other than that, existing notebooks should continue to work, modulo any other breaking changes we're making in 0.17. examples/python/notebook is the main documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jleibs jleibs jleibs approved these changes

Assignees
No one assigned
Labels
include in changelog notebook Jupyter notebooks etc 🕸️ web regarding running the viewer in a browser
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a proper widget to use with notebooks
3 participants
@jprochazk @nikolausWest @jleibs