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.

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

Add Benchmark guide to doc #271

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Add Benchmark guide to doc #271

merged 1 commit into from
Aug 21, 2024

Conversation

duc-nx
Copy link
Contributor

@duc-nx duc-nx commented Aug 15, 2024

Summary:

Add Benchmark.md up to 13-th Fibonacci number.

Copy link

vercel bot commented Aug 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nexus-docs ✅ Ready (Inspect) Visit Preview 13 resolved Aug 21, 2024 9:48pm

@duc-nx duc-nx changed the title Add Benchmark.md Add Benchmark.mdx doc Aug 15, 2024
@duc-nx duc-nx marked this pull request as ready for review August 15, 2024 19:08
@duc-nx duc-nx requested review from sjudson and yoichi-nexus August 19, 2024 15:40
docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
docs/pages/zkvm/_meta.json Outdated Show resolved Hide resolved
docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@sjudson sjudson left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I'd wait on @yoichi-nexus's approval as well before merging

Copy link
Contributor

@yoichi-nexus yoichi-nexus left a comment

Choose a reason for hiding this comment

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

The diff is needed to run the benchmark.

docs/pages/zkvm/sdk-benchmarking.mdx Outdated Show resolved Hide resolved
@duc-nx
Copy link
Contributor Author

duc-nx commented Aug 21, 2024

The doc works after 0.2.3

@yoichi-nexus
Copy link
Contributor

I'm following the doc again.

@duc-nx
Copy link
Contributor Author

duc-nx commented Aug 21, 2024

Okay, I updated the doc which contain the instruction to generate project and show the Cargo.toml in 26e913a

Copy link
Contributor

@yoichi-nexus yoichi-nexus left a comment

Choose a reason for hiding this comment

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

Now I can follow the doc and run the commands! There is one problem: cargo run --release 2>/dev/null doesn't print anything. I could not find performance numbers. My Vercel comment is about this.

Probably the document should explain how to see the performance numbers.

Copy link
Contributor

@yoichi-nexus yoichi-nexus left a comment

Choose a reason for hiding this comment

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

I'm seeing a compilation error

  --> src/main.rs:18:53
   |
18 | fn prove_execution(pp: &PP, prover: Nova<Local>) -> nexus_sdk::nova::seq::Proof {
   |    ---------------                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected `Proof`, found `()`
   |    |
   |    implicitly returns `()` as its body has no tail or `return` expression
19 |     prover.prove(pp).expect("failed to prove program");
   |                                                       - help: remove this semicolon to return this value

when I run cargo run --release

@duc-nx
Copy link
Contributor Author

duc-nx commented Aug 21, 2024

It should work now. I left a typo after modifying the code according to the soft clippy suggestion. ac87b79

Copy link
Contributor

@yoichi-nexus yoichi-nexus left a comment

Choose a reason for hiding this comment

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

Now it's working for me!

Summary:

Add Benchmark.md up to 13-th Fibonacci  number.
@duc-nx duc-nx changed the title Add Benchmark.mdx doc Add Benchmark guide to doc Aug 21, 2024
@duc-nx duc-nx merged commit 4864895 into main Aug 21, 2024
20 checks passed
@duc-nx duc-nx deleted the pr271 branch August 21, 2024 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants