Readme overhaul #751
Merged
Readme overhaul #751
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
|
| Report | Fri, February 16, 2024 at 19:34:25 UTC |
| Project | Stratum v2 (SRI) |
| Branch | readme-update |
| Testbed | sv2 |
| Benchmark | Latency | Latency Results nanoseconds (ns) | (Δ%) |
|---|---|---|
| client_sv2_handle_message_common | ✅ (view plot) | 43.945 |
| client_sv2_handle_message_mining | ✅ (view plot) | 67.182 |
| client_sv2_mining_message_submit_standard | ✅ (view plot) | 14.683 |
| client_sv2_mining_message_submit_standard_serialize | ✅ (view plot) | 270.260 |
| client_sv2_mining_message_submit_standard_serialize_deserialize | ✅ (view plot) | 599.060 |
| client_sv2_open_channel | ✅ (view plot) | 170.440 |
| client_sv2_open_channel_serialize | ✅ (view plot) | 291.850 |
| client_sv2_open_channel_serialize_deserialize | ✅ (view plot) | 373.430 |
| client_sv2_setup_connection | ✅ (view plot) | 163.080 |
| client_sv2_setup_connection_serialize | ✅ (view plot) | 500.850 |
| client_sv2_setup_connection_serialize_deserialize | ✅ (view plot) | 940.610 |
Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help
|
| Report | Fri, February 16, 2024 at 19:34:28 UTC |
| Project | Stratum v2 (SRI) |
| Branch | readme-update |
| Testbed | sv1 |
| Benchmark | Latency | Latency Results nanoseconds (ns) | (Δ%) |
|---|---|---|
| client-submit-serialize | ✅ (view plot) | 6723.200 |
| client-submit-serialize-deserialize | ✅ (view plot) | 7472.200 |
| client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle | ✅ (view plot) | 8201.600 |
| client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle | ✅ (view plot) | 934.860 |
| client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize | ✅ (view plot) | 706.920 |
| client-sv1-authorize-serialize/client-sv1-authorize-serialize | ✅ (view plot) | 247.410 |
| client-sv1-get-authorize/client-sv1-get-authorize | ✅ (view plot) | 157.040 |
| client-sv1-get-submit | ✅ (view plot) | 6498.500 |
| client-sv1-get-subscribe/client-sv1-get-subscribe | ✅ (view plot) | 284.950 |
| client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle | ✅ (view plot) | 765.830 |
| client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize | ✅ (view plot) | 677.130 |
| client-sv1-subscribe-serialize/client-sv1-subscribe-serialize | ✅ (view plot) | 208.240 |
Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help
|
| Report | Fri, February 16, 2024 at 19:34:25 UTC |
| Project | Stratum v2 (SRI) |
| Branch | readme-update |
| Testbed | sv2 |
| Benchmark | Estimated Cycles | Estimated Cycles Results estimated cycles | (Δ%) | Instructions | Instructions Results instructions | (Δ%) | L1 Accesses | L1 Accesses Results accesses | (Δ%) | L2 Accesses | L2 Accesses Results accesses | (Δ%) | RAM Accesses | RAM Accesses Results accesses | (Δ%) |
|---|---|---|---|---|---|---|---|---|---|---|
| client_sv2_handle_message_common | ✅ (view plot) | 2021.000 | ✅ (view plot) | 469.000 | ✅ (view plot) | 731.000 | ✅ (view plot) | 6.000 | ✅ (view plot) | 36.000 |
| client_sv2_handle_message_mining | ✅ (view plot) | 8227.000 | ✅ (view plot) | 2075.000 | ✅ (view plot) | 3052.000 | ✅ (view plot) | 48.000 | ✅ (view plot) | 141.000 |
| client_sv2_mining_message_submit_standard | ✅ (view plot) | 6508.000 | ✅ (view plot) | 1750.000 | ✅ (view plot) | 2543.000 | ✅ (view plot) | 23.000 | ✅ (view plot) | 110.000 |
| client_sv2_mining_message_submit_standard_serialize | ✅ (view plot) | 14661.000 | ✅ (view plot) | 4694.000 | ✅ (view plot) | 6751.000 | ✅ (view plot) | 56.000 | ✅ (view plot) | 218.000 |
| client_sv2_mining_message_submit_standard_serialize_deserialize | ✅ (view plot) | 27352.000 | ✅ (view plot) | 10537.000 | ✅ (view plot) | 15327.000 | ✅ (view plot) | 95.000 | ✅ (view plot) | 330.000 |
| client_sv2_open_channel | ✅ (view plot) | 4523.000 | ✅ (view plot) | 1461.000 | ✅ (view plot) | 2153.000 | ✅ (view plot) | 12.000 | ✅ (view plot) | 66.000 |
| client_sv2_open_channel_serialize | ✅ (view plot) | 13972.000 | ✅ (view plot) | 5064.000 | ✅ (view plot) | 7322.000 | ✅ (view plot) | 42.000 | ✅ (view plot) | 184.000 |
| client_sv2_open_channel_serialize_deserialize | ✅ (view plot) | 22388.000 | ✅ (view plot) | 7979.000 | ✅ (view plot) | 11613.000 | ✅ (view plot) | 76.000 | ✅ (view plot) | 297.000 |
| client_sv2_setup_connection | ✅ (view plot) | 4715.000 | ✅ (view plot) | 1502.000 | ✅ (view plot) | 2275.000 | ✅ (view plot) | 12.000 | ✅ (view plot) | 68.000 |
| client_sv2_setup_connection_serialize | ✅ (view plot) | 16070.000 | ✅ (view plot) | 5963.000 | ✅ (view plot) | 8660.000 | ✅ (view plot) | 47.000 | ✅ (view plot) | 205.000 |
| client_sv2_setup_connection_serialize_deserialize | ✅ (view plot) | 35382.000 | ✅ (view plot) | 14806.000 | ✅ (view plot) | 21747.000 | ✅ (view plot) | 102.000 | ✅ (view plot) | 375.000 |
Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help
|
| Report | Fri, February 16, 2024 at 19:34:24 UTC |
| Project | Stratum v2 (SRI) |
| Branch | readme-update |
| Testbed | sv1 |
| Benchmark | Estimated Cycles | Estimated Cycles Results estimated cycles | (Δ%) | Instructions | Instructions Results instructions | (Δ%) | L1 Accesses | L1 Accesses Results accesses | (Δ%) | L2 Accesses | L2 Accesses Results accesses | (Δ%) | RAM Accesses | RAM Accesses Results accesses | (Δ%) |
|---|---|---|---|---|---|---|---|---|---|---|
| get_authorize | ✅ (view plot) | 8519.000 | ✅ (view plot) | 3772.000 | ✅ (view plot) | 5294.000 | ✅ (view plot) | 8.000 | ✅ (view plot) | 91.000 |
| get_submit | ✅ (view plot) | 95694.000 | ✅ (view plot) | 59522.000 | ✅ (view plot) | 85489.000 | ✅ (view plot) | 60.000 | ✅ (view plot) | 283.000 |
| get_subscribe | ✅ (view plot) | 8092.000 | ✅ (view plot) | 2848.000 | ✅ (view plot) | 3977.000 | ✅ (view plot) | 18.000 | ✅ (view plot) | 115.000 |
| serialize_authorize | ✅ (view plot) | 12344.000 | ✅ (view plot) | 5343.000 | ✅ (view plot) | 7454.000 | ✅ (view plot) | 12.000 | ✅ (view plot) | 138.000 |
| serialize_deserialize_authorize | ✅ (view plot) | 24512.000 | ✅ (view plot) | 9950.000 | ✅ (view plot) | 14052.000 | ✅ (view plot) | 34.000 | ✅ (view plot) | 294.000 |
| serialize_deserialize_handle_authorize | ✅ (view plot) | 30134.000 | ✅ (view plot) | 12127.000 | ✅ (view plot) | 17169.000 | ✅ (view plot) | 59.000 | ✅ (view plot) | 362.000 |
| serialize_deserialize_handle_submit | ✅ (view plot) | 126487.000 | ✅ (view plot) | 73307.000 | ✅ (view plot) | 105087.000 | ✅ (view plot) | 122.000 | ✅ (view plot) | 594.000 |
| serialize_deserialize_handle_subscribe | ✅ (view plot) | 27426.000 | ✅ (view plot) | 9650.000 | ✅ (view plot) | 13651.000 | ✅ (view plot) | 67.000 | ✅ (view plot) | 384.000 |
| serialize_deserialize_submit | ✅ (view plot) | 115279.000 | ✅ (view plot) | 68167.000 | ✅ (view plot) | 97834.000 | ✅ (view plot) | 73.000 | ✅ (view plot) | 488.000 |
| serialize_deserialize_subscribe | ✅ (view plot) | 22926.000 | ✅ (view plot) | 8209.000 | ✅ (view plot) | 11566.000 | ✅ (view plot) | 39.000 | ✅ (view plot) | 319.000 |
| serialize_submit | ✅ (view plot) | 100075.000 | ✅ (view plot) | 61566.000 | ✅ (view plot) | 88335.000 | ✅ (view plot) | 59.000 | ✅ (view plot) | 327.000 |
| serialize_subscribe | ✅ (view plot) | 11485.000 | ✅ (view plot) | 4195.000 | ✅ (view plot) | 5835.000 | ✅ (view plot) | 17.000 | ✅ (view plot) | 159.000 |
Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help
pavlenex
force-pushed
the
readme-update
branch
from
69c5e09
to
7f3e93c
Compare
replace svg logos attempt to fix logos section fix links
pavlenex
force-pushed
the
readme-update
branch
from
7f3e93c
to
52e59ee
Compare
GitGab19
reviewed
Feb 16, 2024
pavlenex
force-pushed
the
readme-update
branch
from
97d785a
to
2ae8dbd
Compare
attempt to fix getting started link
pavlenex
force-pushed
the
readme-update
branch
from
2ae8dbd
to
c201b0a
Compare
|
@GitGab19 Thanks for a review, I've added spacing with emojies, the only compromise there is that I had to add an ugly link for getting started guide, but that's a minor thing. I've also fixed few typos I found and the one you reported. |
|
@Fi3 when you get a chance, review and merge. |
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.
Closes #738
Besides of looking at diff, I think this readme can be tested here on my fork as well, to get a better feeling on the visual changes.
I've removed a lot of stuff and tried to keep it consistent, if I removed something important, let me know. I believe a lot of what was removed was outdated or too specific and instead better suited for dev docs.
One thing I failed to figure out how to do properly is "Supporters" logos, I hope someone can help me with aligning them properly and scaling.
Looking forward to feedback!