Automatic weights documentation

Parse the weight files to calculate both extrinsic weights and relative weights, and include the results in the documentation #128 (closed).

This requires:

1. The pallet weights computed on the reference machine.
2. The extrinsic weights computed on the reference machine to get the weight overhead of the execution of one extrinsic.
3. The paritydb weights computed on the reference machine to get the weight of read and write in the database.

Include in the docs: The relative weight for all extrinsics available as:

$$\frac{weight_{extrinsic_base} + weight_{extrinsic}}{weight_{block}}*100$$

• In the case where the extrinsic has a complexity parameter, the weight is calculated as the worst-case scenario, i.e., the maximal value set during benchmarking.
• In the case where no weight is available, the value is set to -1% and translated to "No weight available" in the doc.

To-do list:

• parse weight files.
• compute weights from files.
• add relative weight in % of block max.
• fix overhead benchmark.
• include computed weights in the autogenerated documentation.
• fix missing weights.
• automatic block max extraction from metadata.

assigned to @bgallois

changed the description

added 1 commit

• f5419851 - add weights computation from weight files

Compare with previous version

changed the description

added 1 commit

• 3b59192c - fix weight evaluation with complexity parameters

Compare with previous version

added 1 commit

• b9da1a76 - fix weight evaluation with complexity parameters

Compare with previous version

added 1 commit

• 7333846c - add relative weight

Compare with previous version

marked the checklist item fix subweight_core issue with complexity parameters. as completed

changed the description

marked the checklist item add relative weight in % of block max. as completed

added 1 commit

• 9cff5f5d - fix overhead benchmark

Compare with previous version

changed the description

added 1 commit

• 0da77060 - update all weights

Compare with previous version

added 1 commit

• a787b7fe - rework at a lib

Compare with previous version

added 1 commit

• 1457b101 - rework at a lib

Compare with previous version

added 1 commit

• cf27e889 - rework at a lib

Compare with previous version

added 1 commit

• 9108f75e - rework as a lib

Compare with previous version

added RN-silent label

changed milestone to %runtime-800

added 2 commits

• 03320e1d - add to workspace
• b328921f - add max_block_weight

Compare with previous version

added 1 commit

• 722e570b - fix weight analyzer

Compare with previous version

added 1 commit

• baa4a50b - add weights to doc

Compare with previous version

added 1 commit

• 3606018a - add weights to doc

Compare with previous version

marked the checklist item include computed weights in the autogenerated documentation. as completed

changed the description

added 1 commit

• cbb9938c - add weights to doc

Compare with previous version

added 1 commit

• 76cbf239 - fix readability

Compare with previous version

added 1 commit

• c8d99448 - update metadata

Compare with previous version

added 1 commit

• 8d7f0d31 - add extrinsic base weight overhead

Compare with previous version

added 1 commit

• 99bfde6d - update docs

Compare with previous version

marked the checklist item fix missing weights. as completed

changed the description

added 1 commit

• 12ee6f18 - remove all unwrap

Compare with previous version

added 1 commit

• ab7501c1 - add automatic max block weight from metadata

Compare with previous version

added 1 commit

• c32a1e76 - add generic constructor

Compare with previous version

added 1 commit

• b43399d6 - refactor using if let chaining

Compare with previous version

added 1 commit

• 00d4ed05 - refactor doc generation

Compare with previous version

added 1 commit

• d6fd10b6 - refactor error handling

Compare with previous version

changed the description

requested review from @HugoTrentesaux

marked this merge request as ready

In the case where no weight is available, the value is set to 0%.

Since the documentation is targeting human reader, the following is not informative enough:

transfer(dest, value)

Taking 0 % of a block.

This can be fixed by only changing the template to something like

{% if call.weight == 0 %}
No available weight.
{% else %}
Taking {{ call.weight }} % of a block.
{% endif %}

(see https://keats.github.io/tera/docs/#if for template documentation).

The MR is a nice addition and a good step towards #128 (closed).

added 1 commit

• 56dcf1da - add const documentation

Compare with previous version

added 1 commit

• a1caf6e7 - fix no weight

Compare with previous version

approved this merge request

changed the description

added 24 commits

• a1caf6e7...bd45d2f6 - 2 commits from branch nodes/rust:master
• bd45d2f6...8e2b1a46 - 12 earlier commits
• 5de41fad - add extrinsic base weight overhead
• 073d4308 - update docs
• 00adb9aa - remove all unwrap
• b03cc8f3 - add automatic max block weight from metadata
• 8e1af7f5 - add generic constructor
• 06e9be76 - refactor using if let chaining
• a421ce35 - refactor doc generation
• 84417ec3 - refactor error handling
• 7a0d89d1 - add const documentation
• 67b1e8f8 - fix no weight

Compare with previous version

resolved all threads

enabled an automatic merge when the pipeline for 67b1e8f8 succeeds

merged

mentioned in commit 23c25376

mentioned in issue #128 (closed)