[Notebooks] Types for modal-kernelshim to publish outputs #2764
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
This allows the server to get outputs from running cells in modal-kernelshim.
ekzhang
commented
Jan 15, 2025
modal_proto/api.proto
Outdated
Comment on lines
1924
to
1925
| // See kernelshim.py for the differences between this and `ExecuteResult`. | ||
| // https://jupyter-client.readthedocs.io/en/stable/messaging.html#execution-results |
There was a problem hiding this comment.
This isn't committed yet, here's an explanation
# The reply is not returned until after the cell finishes running. Although the
# `execute_result` output message contains the execution count and status, this is only
# returned by ipykernel if the last line of the cell evaluates to a non-null value.
#
# So, we still need to send this message to the server to get the true execution count
# for cells that do not produce an `execute_result` message.
reply = await pending
|
@prbot approve Merging for now, still looking forward to feedback though! We discussed a bit in the office already. And after this we'll probably need to iterate further still. |
![modal-pr-review-automation[bot]](https://avatars.githubusercontent.com/in/335990?s=60&v=4){kind=small}
|
@prbot approve Merging for now, still looking forward to feedback though! We discussed a bit in the office already. And after this we'll probably need to iterate further still. |
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.
This allows the server to get outputs from running cells in modal-kernelshim.
Reference: https://jupyter-client.readthedocs.io/en/stable/messaging.html
Describe your changes
Why is this public protobuf? It's in here because kernelshim exists within the sandbox running user code. It can't access public information.
Why is this re-encoded in this funny way? It's part of the technical design that will allow us to implement collaborative editing and cloud-based kernels. (Also, on the server side, we'll need to figure out how to store potentially large outputs, possibly separate from other outputs.)
How will this be authenticated? Using an authentication passed into the sandbox. We could use task_id / task_secret, except sandboxes don't have that, so probably something else.
Notebook progress
Map of current progress. This PR is the yellow part.