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

Update docs for 0.18 #868

Merged
merged 8 commits into from
Sep 13, 2023
Merged

Update docs for 0.18 #868

merged 8 commits into from
Sep 13, 2023

Conversation

tzerrell
Copy link
Member

Updates the docs.rs docs for the upcoming 0.18 release. This has three main parts:

  • Updating the introduction to the guest module
  • Porting the receipts documentation to live on the Receipt object, so it is not hidden after the module restructure.
  • Porting the prover documentation to live on the Prover object, so it is not hidden after the module restructure.

I also revised during these ports, in particular expanding the Prover example code.

@github-actions
Copy link

Benchmark for Linux-cuda f58c9a0

Click to hide benchmark
Test Base PR %
fib/100/execute 5.1±0.11ms 5.0±0.10ms -1.96%
fib/100/prove 708.4±4.85ms 699.5±5.35ms -1.26%
fib/100/total 711.9±4.84ms 703.1±5.26ms -1.24%
fib/1000/execute 5.6±0.10ms 5.6±0.10ms 0.00%
fib/1000/prove 737.6±5.33ms 730.6±5.12ms -0.95%
fib/1000/total 745.9±2.89ms 739.3±5.62ms -0.88%
fib/10000/execute 11.3±0.11ms 11.2±0.10ms -0.88%
fib/10000/prove 2.9±0.02s 2.8±0.01s -3.45%
fib/10000/total 2.9±0.02s 2.8±0.02s -3.45%

Benchmark for Linux-default f58c9a0

Click to hide benchmark
Test Base PR %
fib/100/execute 6.9±0.46ms 6.8±0.34ms -1.45%
fib/100/prove 5.0±0.03s 5.0±0.03s 0.00%
fib/100/total 5.0±0.03s 5.0±0.02s 0.00%
fib/1000/execute 8.1±0.43ms 7.9±0.55ms -2.47%
fib/1000/prove 5.0±0.03s 5.0±0.01s 0.00%
fib/1000/total 5.0±0.02s 5.0±0.03s 0.00%
fib/10000/execute 15.1±0.48ms 14.9±0.63ms -1.32%
fib/10000/prove 20.9±0.11s 20.6±0.05s -1.44%
fib/10000/total 20.9±0.08s 20.6±0.04s -1.44%

Benchmark for macOS-default f58c9a0

Click to hide benchmark
Test Base PR %
fib/100/execute 2.8±0.11ms 2.7±0.12ms -3.57%
fib/100/prove 3.7±0.06s 3.6±0.06s -2.70%
fib/100/total 3.6±0.03s 3.6±0.07s 0.00%
fib/1000/execute 3.1±0.09ms 3.0±0.09ms -3.23%
fib/1000/prove 3.7±0.06s 3.6±0.06s -2.70%
fib/1000/total 3.7±0.06s 3.7±0.05s 0.00%
fib/10000/execute 6.0±0.14ms 5.8±0.09ms -3.33%
fib/10000/prove 15.0±0.09s 15.0±0.10s 0.00%
fib/10000/total 15.0±0.13s 15.0±0.12s 0.00%

Benchmark for macOS-metal

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

/// [SuccinctReceipt].
#[derive(Debug, Deserialize, Serialize, PartialEq)]
pub enum InnerReceipt {
/// The [SegmentReceipts].
/// The [SegmentReceipt]s.
Copy link
Member

Choose a reason for hiding this comment

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

This is wrong, it actually is [SegmentReceipts] which is distinct from [SegmentReceipt]

@@ -269,6 +257,9 @@ impl InnerReceipt {
}

/// Returns the [InnerReceipt::Flat] arm.
///
/// Returns this arm as a slice of [SegmentReceipt]s, as the
/// `SegmentReceipts` type used to hold them is a private type.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to mention that SegmentReceipts is a private type, and honestly I think SegmentReceipts needs to be a public type.

@flaub flaub added the release label Sep 13, 2023
@github-actions
Copy link

Benchmark for Linux-cuda 78bae1f

Click to hide benchmark
Test Base PR %
fib/100/execute 5.2±0.10ms 5.1±0.16ms -1.92%
fib/100/prove 1501.3±35.95ms 753.2±26.05ms -49.83%
fib/100/total 1321.2±38.58ms 706.0±6.29ms -46.56%
fib/1000/execute 5.7±0.09ms 5.7±0.15ms 0.00%
fib/1000/prove 1483.5±37.07ms 779.7±6.87ms -47.44%
fib/1000/total 1331.3±17.39ms 734.1±7.21ms -44.86%
fib/10000/execute 11.3±0.13ms 11.3±0.20ms 0.00%
fib/10000/prove 4.5±0.04s 3.2±0.01s -28.89%
fib/10000/total 4.3±0.01s 3.2±0.01s -25.58%

Benchmark for Linux-default

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

Benchmark for macOS-default 78bae1f

Click to hide benchmark
Test Base PR %
fib/100/execute 2.8±0.14ms 2.8±0.11ms 0.00%
fib/100/prove 3.7±0.07s 3.6±0.04s -2.70%
fib/100/total 3.7±0.08s 3.6±0.07s -2.70%
fib/1000/execute 3.1±0.06ms 3.0±0.16ms -3.23%
fib/1000/prove 3.6±0.06s 3.6±0.09s 0.00%
fib/1000/total 3.7±0.06s 3.6±0.04s -2.70%
fib/10000/execute 6.0±0.08ms 5.9±0.05ms -1.67%
fib/10000/prove 15.0±0.09s 15.0±0.08s 0.00%
fib/10000/total 15.1±0.09s 15.0±0.16s -0.66%

Benchmark for macOS-metal

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

@github-actions
Copy link

Benchmark for Linux-cuda 4508278

Click to hide benchmark
Test Base PR %
fib/100/execute 5.1±0.12ms 5.0±0.09ms -1.96%
fib/100/prove 1151.0±18.61ms 847.5±20.53ms -26.37%
fib/100/total 1095.9±8.61ms 842.8±12.77ms -23.10%
fib/1000/execute 5.7±0.10ms 5.7±0.11ms 0.00%
fib/1000/prove 1149.0±11.47ms 870.7±11.39ms -24.22%
fib/1000/total 1131.7±5.71ms 886.9±18.73ms -21.63%
fib/10000/execute 11.4±0.13ms 11.3±0.13ms -0.88%
fib/10000/prove 3.4±0.02s 3.4±0.02s 0.00%
fib/10000/total 3.4±0.02s 3.4±0.01s 0.00%

Benchmark for Linux-default

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

Benchmark for macOS-default

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

Benchmark for macOS-metal

    <details open>
      <summary>Click to hide benchmark</summary>
      Benchmarks have changed between the two branches, unable to diff.
    </details>

@flaub flaub merged commit 6cee6e8 into main Sep 13, 2023
20 checks passed
@flaub flaub deleted the tzerrell/docs-0.18 branch September 13, 2023 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants