Update documentation about read_vec function in SP1 gitbook #1840
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
|
Thanks this is a good callout. We have a new documentation framework coming soon, so Im not gonna merge this PR yet but will make sure its included next release. |
puma314
approved these changes
Dec 15, 2024
|
Dumb question: I have almost entirely worked with Phabricator as a code review system before. Is there something I'm supposed to do to get this PR merged? Or is the ball in somebody else's court now? Thanks! |
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.
Motivation
I am working on an SP1 application that reads in ~200kB of input data from input. I was able to improve prover performance by a factor of 3 by replacing read with read_vec. I had to figure this out by reading code, so I want to document this big performance difference in the relevant documentation.
Solution
I am just documenting this for now, but when Rust adds specialization for functions, read<Vec> should just default to a non-serializing version by default. (specialization is a nightly feature right now)
PR Checklist