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.

Sign up for GitHub

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

Jump to bottom

Update CONTRIBUTING.md #1030

Closed
wants to merge 1 commit into from
Closed

Update CONTRIBUTING.md #1030

wants to merge 1 commit into from

Conversation

marathon-gary
Copy link
Contributor

@marathon-gary marathon-gary commented Jul 3, 2024 •
edited by rrybarczyk
Loading

Context: #903 (comment)

@marathon-gary marathon-gary mentioned this pull request Jul 3, 2024
Open
@plebhash
Copy link
Collaborator

plebhash commented Jul 4, 2024 •
edited
Loading

hey @marathon-gary thanks for this contribution!

since we are updating the CONTRIBUTING.md file, we should bring the following discussion here:

#1021 (comment)

@plebhash plebhash mentioned this pull request Jul 4, 2024
Merged
@jbesraa
Copy link
Contributor

jbesraa commented Jul 8, 2024

@plebhash is the PR thing still needed after the change @Fi3 did in the branch settings?

@marathon-gary
Copy link
Contributor Author

@plebhash is the PR thing still needed after the change @Fi3 did in the branch settings?

Is there a branch setting that enforces code organization now?

@plebhash
Copy link
Collaborator

plebhash commented Jul 8, 2024

@plebhash is the PR thing still needed after the change @Fi3 did in the branch settings?

I just rebased this PR as a test. It seems I was still included as a co-author.

Is there a branch setting that enforces code organization now

@jbesraa was referring to this: #1030 (comment)

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 8, 2024

🐰Bencher

ReportMon, July 8, 2024 at 19:31:02 UTC
ProjectStratum v2 (SRI)
Branch1030/merge
Testbedsv1
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)		Latency Upper Boundary
nanoseconds (ns) | (%)
client-submit-serialize✅ (view plot)6,432.80 (-7.14%)7,356.74 (87.44%)
client-submit-serialize-deserialize✅ (view plot)7,393.00 (-5.79%)8,335.10 (88.70%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle✅ (view plot)8,017.30 (-4.74%)8,843.07 (90.66%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle✅ (view plot)883.79 (-1.59%)926.74 (95.37%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize✅ (view plot)696.02 (-0.14%)717.87 (96.96%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize✅ (view plot)245.21 (-1.15%)255.19 (96.09%)
client-sv1-get-authorize/client-sv1-get-authorize✅ (view plot)157.19 (+0.02%)162.45 (96.76%)
client-sv1-get-submit✅ (view plot)6,273.70 (-6.27%)7,143.34 (87.83%)
client-sv1-get-subscribe/client-sv1-get-subscribe✅ (view plot)282.96 (+1.52%)291.47 (97.08%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle✅ (view plot)765.22 (+2.38%)777.19 (98.46%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize✅ (view plot)610.76 (-0.57%)637.60 (95.79%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize✅ (view plot)202.60 (-1.94%)219.99 (92.09%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 8, 2024

🐰Bencher

ReportMon, July 8, 2024 at 19:31:02 UTC
ProjectStratum v2 (SRI)
Branchpatch-2
Testbedsv2

🚨 13 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client_sv2_mining_message_submit_standardL2 Accesses (accesses)🚨 (view plot | view alert)26.00 (+48.33%)22.94 (113.36%)
client_sv2_mining_message_submit_standard_serializeL2 Accesses (accesses)🚨 (view plot | view alert)55.00 (+16.27%)52.36 (105.05%)
client_sv2_mining_message_submit_standard_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)10,585.00 (+0.41%)10,563.46 (100.20%)
client_sv2_mining_message_submit_standard_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)15,399.00 (+0.39%)15,368.10 (100.20%)
client_sv2_mining_message_submit_standard_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)90.00 (+7.48%)89.50 (100.56%)
client_sv2_open_channel_serializeL2 Accesses (accesses)🚨 (view plot | view alert)42.00 (+12.82%)41.79 (100.49%)
client_sv2_open_channel_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)8,027.00 (+0.54%)8,005.91 (100.26%)
client_sv2_open_channel_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)11,672.00 (+0.50%)11,643.25 (100.25%)
client_sv2_open_channel_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)84.00 (+14.57%)82.05 (102.38%)
client_sv2_setup_connectionL2 Accesses (accesses)🚨 (view plot | view alert)15.00 (+65.28%)13.59 (110.35%)
client_sv2_setup_connection_serializeL2 Accesses (accesses)🚨 (view plot | view alert)49.00 (+9.81%)49.00 (100.01%)
client_sv2_setup_connection_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)14,855.00 (+0.30%)14,833.10 (100.15%)
client_sv2_setup_connection_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)21,811.00 (+0.28%)21,779.64 (100.14%)

Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)		Estimated Cycles Upper Boundary
estimated cycles | (%)		InstructionsInstructions Results
instructions | (Δ%)		Instructions Upper Boundary
instructions | (%)		L1 AccessesL1 Accesses Results
accesses | (Δ%)		L1 Accesses Upper Boundary
accesses | (%)		L2 AccessesL2 Accesses Results
accesses | (Δ%)		L2 Accesses Upper Boundary
accesses | (%)		RAM AccessesRAM Accesses Results
accesses | (Δ%)		RAM Accesses Upper Boundary
accesses | (%)
client_sv2_handle_message_common✅ (view plot)2,111.00 (+2.98%)2,128.97 (99.16%)✅ (view plot)473.00 (+0.50%)486.49 (97.23%)✅ (view plot)731.00 (-0.16%)755.48 (96.76%)✅ (view plot)10.00 (+44.81%)10.55 (94.80%)✅ (view plot)38.00 (+3.65%)38.62 (98.39%)
client_sv2_handle_message_mining✅ (view plot)8,219.00 (+0.27%)8,337.47 (98.58%)✅ (view plot)2,137.00 (+0.47%)2,171.53 (98.41%)✅ (view plot)3,159.00 (+0.47%)3,216.44 (98.21%)✅ (view plot)39.00 (+1.22%)43.65 (89.35%)✅ (view plot)139.00 (+0.11%)142.00 (97.89%)
client_sv2_mining_message_submit_standard✅ (view plot)6,316.00 (+0.64%)6,390.81 (98.83%)✅ (view plot)1,750.00 (+0.03%)1,763.31 (99.25%)✅ (view plot)2,546.00 (-0.30%)2,576.19 (98.83%)🚨 (view plot | view alert)26.00 (+48.33%)22.94 (113.36%)✅ (view plot)104.00 (+0.15%)106.95 (97.24%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)14,657.00 (-0.80%)15,036.62 (97.48%)✅ (view plot)4,694.00 (+0.01%)4,707.31 (99.72%)✅ (view plot)6,752.00 (-0.04%)6,775.49 (99.65%)🚨 (view plot | view alert)55.00 (+16.27%)52.36 (105.05%)✅ (view plot)218.00 (-1.99%)230.05 (94.76%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)27,469.00 (-0.03%)27,847.92 (98.64%)🚨 (view plot | view alert)10,585.00 (+0.41%)10,563.46 (100.20%)🚨 (view plot | view alert)15,399.00 (+0.39%)15,368.10 (100.20%)🚨 (view plot | view alert)90.00 (+7.48%)89.50 (100.56%)✅ (view plot)332.00 (-0.85%)345.43 (96.11%)
client_sv2_open_channel✅ (view plot)4,451.00 (-0.93%)4,611.25 (96.52%)✅ (view plot)1,461.00 (+0.06%)1,474.58 (99.08%)✅ (view plot)2,156.00 (+0.16%)2,173.08 (99.21%)✅ (view plot)11.00 (-8.19%)15.27 (72.05%)✅ (view plot)64.00 (-1.77%)68.17 (93.88%)
client_sv2_open_channel_serialize✅ (view plot)14,040.00 (-1.25%)14,462.53 (97.08%)✅ (view plot)5,064.00 (+0.02%)5,077.58 (99.73%)✅ (view plot)7,320.00 (+0.03%)7,339.50 (99.73%)🚨 (view plot | view alert)42.00 (+12.82%)41.79 (100.49%)✅ (view plot)186.00 (-3.04%)198.91 (93.51%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)22,557.00 (-0.37%)23,028.31 (97.95%)🚨 (view plot | view alert)8,027.00 (+0.54%)8,005.91 (100.26%)🚨 (view plot | view alert)11,672.00 (+0.50%)11,643.25 (100.25%)🚨 (view plot | view alert)84.00 (+14.57%)82.05 (102.38%)✅ (view plot)299.00 (-1.83%)315.11 (94.89%)
client_sv2_setup_connection✅ (view plot)4,693.00 (-0.13%)4,765.17 (98.49%)✅ (view plot)1,502.00 (+0.06%)1,515.58 (99.10%)✅ (view plot)2,273.00 (-0.17%)2,299.96 (98.83%)🚨 (view plot | view alert)15.00 (+65.28%)13.59 (110.35%)✅ (view plot)67.00 (-1.33%)69.61 (96.26%)
client_sv2_setup_connection_serialize✅ (view plot)15,976.00 (-1.78%)16,491.05 (96.88%)✅ (view plot)5,963.00 (+0.01%)5,976.58 (99.77%)✅ (view plot)8,661.00 (+0.07%)8,677.77 (99.81%)🚨 (view plot | view alert)49.00 (+9.81%)49.00 (100.01%)✅ (view plot)202.00 (-4.30%)217.50 (92.87%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)35,416.00 (-0.33%)35,749.53 (99.07%)🚨 (view plot | view alert)14,855.00 (+0.30%)14,833.10 (100.15%)🚨 (view plot | view alert)21,811.00 (+0.28%)21,779.64 (100.14%)✅ (view plot)110.00 (+10.40%)112.90 (97.43%)✅ (view plot)373.00 (-1.73%)384.65 (96.97%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 8, 2024

🐰Bencher

ReportMon, July 8, 2024 at 19:31:03 UTC
ProjectStratum v2 (SRI)
Branchpatch-2
Testbedsv1

🚨 2 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
serialize_deserialize_authorizeRAM Accesses (accesses)🚨 (view plot | view alert)298.00 (+1.08%)297.68 (100.11%)
serialize_deserialize_handle_authorizeRAM Accesses (accesses)🚨 (view plot | view alert)369.00 (+1.42%)367.07 (100.53%)

Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)		Estimated Cycles Upper Boundary
estimated cycles | (%)		InstructionsInstructions Results
instructions | (Δ%)		Instructions Upper Boundary
instructions | (%)		L1 AccessesL1 Accesses Results
accesses | (Δ%)		L1 Accesses Upper Boundary
accesses | (%)		L2 AccessesL2 Accesses Results
accesses | (Δ%)		L2 Accesses Upper Boundary
accesses | (%)		RAM AccessesRAM Accesses Results
accesses | (Δ%)		RAM Accesses Upper Boundary
accesses | (%)
get_authorize✅ (view plot)8,504.00 (+0.82%)8,726.41 (97.45%)✅ (view plot)3,746.00 (+0.15%)3,856.71 (97.13%)✅ (view plot)5,249.00 (+0.08%)5,403.56 (97.14%)✅ (view plot)7.00 (-12.09%)10.43 (67.14%)✅ (view plot)92.00 (+2.22%)93.99 (97.88%)
get_submit✅ (view plot)95,471.00 (-0.09%)96,150.25 (99.29%)✅ (view plot)59,439.00 (-0.05%)59,783.10 (99.42%)✅ (view plot)85,361.00 (-0.05%)85,842.86 (99.44%)✅ (view plot)48.00 (-13.05%)62.61 (76.66%)✅ (view plot)282.00 (-0.03%)287.77 (98.00%)
get_subscribe✅ (view plot)7,949.00 (-0.35%)8,274.40 (96.07%)✅ (view plot)2,841.00 (+0.40%)2,940.93 (96.60%)✅ (view plot)3,974.00 (+0.52%)4,101.02 (96.90%)✅ (view plot)11.00 (-32.11%)19.95 (55.14%)✅ (view plot)112.00 (-0.58%)117.00 (95.73%)
serialize_authorize✅ (view plot)12,257.00 (+0.42%)12,505.51 (98.01%)✅ (view plot)5,317.00 (+0.11%)5,427.71 (97.96%)✅ (view plot)7,412.00 (+0.06%)7,566.90 (97.95%)✅ (view plot)10.00 (-7.53%)13.41 (74.56%)✅ (view plot)137.00 (+1.08%)140.24 (97.69%)
serialize_deserialize_authorize✅ (view plot)24,554.00 (+0.35%)24,709.02 (99.37%)✅ (view plot)9,898.00 (-0.02%)10,027.94 (98.70%)✅ (view plot)13,959.00 (-0.06%)14,153.69 (98.62%)✅ (view plot)33.00 (-9.95%)41.63 (79.27%)🚨 (view plot | view alert)298.00 (+1.08%)297.68 (100.11%)
serialize_deserialize_handle_authorize✅ (view plot)30,323.00 (+0.59%)30,342.35 (99.94%)✅ (view plot)12,101.00 (+0.05%)12,211.71 (99.09%)✅ (view plot)17,118.00 (+0.00%)17,282.17 (99.05%)✅ (view plot)58.00 (-1.26%)64.71 (89.63%)🚨 (view plot | view alert)369.00 (+1.42%)367.07 (100.53%)
serialize_deserialize_handle_submit✅ (view plot)126,402.00 (-0.01%)127,039.79 (99.50%)✅ (view plot)73,224.00 (-0.04%)73,625.57 (99.45%)✅ (view plot)104,947.00 (-0.04%)105,519.61 (99.46%)✅ (view plot)119.00 (-1.24%)131.42 (90.55%)✅ (view plot)596.00 (+0.20%)599.25 (99.46%)
serialize_deserialize_handle_subscribe✅ (view plot)27,495.00 (+0.15%)27,603.05 (99.61%)✅ (view plot)9,643.00 (+0.12%)9,742.93 (98.97%)✅ (view plot)13,640.00 (+0.13%)13,777.01 (99.01%)✅ (view plot)62.00 (-6.01%)73.89 (83.91%)✅ (view plot)387.00 (+0.32%)388.58 (99.59%)
serialize_deserialize_submit✅ (view plot)114,995.00 (-0.08%)115,661.77 (99.42%)✅ (view plot)68,001.00 (-0.08%)68,408.16 (99.40%)✅ (view plot)97,560.00 (-0.09%)98,158.49 (99.39%)✅ (view plot)64.00 (-7.91%)75.35 (84.93%)✅ (view plot)489.00 (+0.19%)492.41 (99.31%)
serialize_deserialize_subscribe✅ (view plot)22,884.00 (+0.04%)23,113.93 (99.01%)✅ (view plot)8,195.00 (+0.11%)8,298.75 (98.75%)✅ (view plot)11,544.00 (+0.13%)11,684.53 (98.80%)✅ (view plot)35.00 (-11.27%)44.15 (79.28%)✅ (view plot)319.00 (+0.15%)321.52 (99.22%)
serialize_submit✅ (view plot)99,788.00 (-0.11%)100,478.51 (99.31%)✅ (view plot)61,483.00 (-0.05%)61,832.56 (99.43%)✅ (view plot)88,208.00 (-0.05%)88,696.49 (99.45%)✅ (view plot)48.00 (-14.00%)62.27 (77.08%)✅ (view plot)324.00 (-0.21%)329.25 (98.41%)
serialize_subscribe✅ (view plot)11,286.00 (-0.36%)11,610.34 (97.21%)✅ (view plot)4,188.00 (+0.27%)4,287.93 (97.67%)✅ (view plot)5,831.00 (+0.33%)5,960.29 (97.83%)✅ (view plot)13.00 (-20.50%)19.10 (68.05%)✅ (view plot)154.00 (-0.80%)159.82 (96.36%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 8, 2024

🐰Bencher

ReportMon, July 8, 2024 at 19:31:10 UTC
ProjectStratum v2 (SRI)
Branchpatch-2
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)		Latency Upper Boundary
nanoseconds (ns) | (%)
client_sv2_handle_message_common✅ (view plot)44.73 (+0.39%)45.25 (98.86%)
client_sv2_handle_message_mining✅ (view plot)72.55 (-0.40%)80.43 (90.20%)
client_sv2_mining_message_submit_standard✅ (view plot)14.66 (+0.08%)14.69 (99.81%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)256.38 (-2.95%)284.00 (90.27%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)591.80 (-0.40%)628.02 (94.23%)
client_sv2_open_channel✅ (view plot)166.01 (+0.22%)171.31 (96.91%)
client_sv2_open_channel_serialize✅ (view plot)275.68 (-2.65%)293.20 (94.02%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)372.86 (-1.45%)424.35 (87.87%)
client_sv2_setup_connection✅ (view plot)160.75 (-2.06%)175.00 (91.86%)
client_sv2_setup_connection_serialize✅ (view plot)445.67 (-6.09%)505.98 (88.08%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)978.29 (+0.78%)1,038.46 (94.21%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

@plebhash plebhash mentioned this pull request Jul 8, 2024
Closed
@rrybarczyk rrybarczyk marked this pull request as draft July 17, 2024 13:58
@plebhash plebhash changed the base branch from dev to main August 28, 2024 20:17
@marathon-gary
Copy link
Contributor Author

Moved here to discuss and deduce a comprehensive solution.
#1157

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plebhash plebhash plebhash approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@marathon-gary @plebhash @jbesraa