Skip to content

Commit

Permalink
Merge pull request #523 from pq-code-package/readme_fix
Browse files Browse the repository at this point in the history 
README: Fix broken link
  • Loading branch information
@mkannwischer
mkannwischer authored Dec 13, 2024
2 parents 7938203 + 4ccf835 commit e7721c6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ as templates.

If your library has a FIPS-202 implementation, you can use it instead of the one shipped with mlkem-native: Replace
[`fips202/*`](fips202) by your FIPS-202 implementation, and make sure to include replacements for the headers
[`fips202/fips202.h`](fips202/fips202.h) and [`fips202/fips202x4.h`] and the functionalities specified
[`fips202/fips202.h`](fips202/fips202.h) and [`fips202/fips202x4.h`](fips202/fips202x4.h) and the functionalities specified
therein. See [FIPS202.md](FIPS202.md) for details.

### Do I need to setup CBMC to use mlkem-native?
Expand Down

18 comments on commit e7721c6

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Arm Cortex-A76 (Raspberry Pi 5) benchmarks

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 29185 cycles 29184 cycles 1.00
ML-KEM-512 encaps 35553 cycles 35554 cycles 1.00
ML-KEM-512 decaps 46096 cycles 46096 cycles 1
ML-KEM-768 keypair 49230 cycles 49232 cycles 1.00
ML-KEM-768 encaps 55386 cycles 55387 cycles 1.00
ML-KEM-768 decaps 70236 cycles 70238 cycles 1.00
ML-KEM-1024 keypair 72218 cycles 72217 cycles 1.00
ML-KEM-1024 encaps 81131 cycles 81134 cycles 1.00
ML-KEM-1024 decaps 100870 cycles 100872 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Intel Xeon 4th gen (c7i)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 13508 cycles 13511 cycles 1.00
ML-KEM-512 encaps 17253 cycles 17254 cycles 1.00
ML-KEM-512 decaps 22734 cycles 22752 cycles 1.00
ML-KEM-768 keypair 22530 cycles 22492 cycles 1.00
ML-KEM-768 encaps 24496 cycles 24454 cycles 1.00
ML-KEM-768 decaps 32553 cycles 32432 cycles 1.00
ML-KEM-1024 keypair 31374 cycles 31390 cycles 1.00
ML-KEM-1024 encaps 34932 cycles 34968 cycles 1.00
ML-KEM-1024 decaps 45821 cycles 45865 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Intel Xeon 3rd gen (c6i)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 20328 cycles 20333 cycles 1.00
ML-KEM-512 encaps 27006 cycles 27300 cycles 0.99
ML-KEM-512 decaps 35807 cycles 35807 cycles 1
ML-KEM-768 keypair 34899 cycles 34880 cycles 1.00
ML-KEM-768 encaps 38170 cycles 38168 cycles 1.00
ML-KEM-768 decaps 50924 cycles 50887 cycles 1.00
ML-KEM-1024 keypair 47963 cycles 48000 cycles 1.00
ML-KEM-1024 encaps 54129 cycles 54192 cycles 1.00
ML-KEM-1024 decaps 71671 cycles 71702 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

AMD EPYC 3rd gen (c6a)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 18199 cycles 18134 cycles 1.00
ML-KEM-512 encaps 23187 cycles 23194 cycles 1.00
ML-KEM-512 decaps 30510 cycles 30514 cycles 1.00
ML-KEM-768 keypair 31122 cycles 31094 cycles 1.00
ML-KEM-768 encaps 34154 cycles 34184 cycles 1.00
ML-KEM-768 decaps 44709 cycles 44761 cycles 1.00
ML-KEM-1024 keypair 44575 cycles 44796 cycles 1.00
ML-KEM-1024 encaps 49926 cycles 50098 cycles 1.00
ML-KEM-1024 decaps 64530 cycles 64335 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

AMD EPYC 4th gen (c7a)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 15077 cycles 15084 cycles 1.00
ML-KEM-512 encaps 19649 cycles 19666 cycles 1.00
ML-KEM-512 decaps 26298 cycles 26330 cycles 1.00
ML-KEM-768 keypair 25594 cycles 25626 cycles 1.00
ML-KEM-768 encaps 28151 cycles 28271 cycles 1.00
ML-KEM-768 decaps 37929 cycles 37873 cycles 1.00
ML-KEM-1024 keypair 35554 cycles 35570 cycles 1.00
ML-KEM-1024 encaps 40962 cycles 40986 cycles 1.00
ML-KEM-1024 decaps 54477 cycles 54592 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton4

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 18206 cycles 18201 cycles 1.00
ML-KEM-512 encaps 22233 cycles 22233 cycles 1
ML-KEM-512 decaps 28995 cycles 28995 cycles 1
ML-KEM-768 keypair 30681 cycles 30677 cycles 1.00
ML-KEM-768 encaps 33737 cycles 33738 cycles 1.00
ML-KEM-768 decaps 43314 cycles 43315 cycles 1.00
ML-KEM-1024 keypair 44374 cycles 44370 cycles 1.00
ML-KEM-1024 encaps 49789 cycles 49789 cycles 1
ML-KEM-1024 decaps 62853 cycles 62850 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Intel Xeon 4th gen (c7i) (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 34774 cycles 34868 cycles 1.00
ML-KEM-512 encaps 44901 cycles 45024 cycles 1.00
ML-KEM-512 decaps 58720 cycles 58932 cycles 1.00
ML-KEM-768 keypair 59241 cycles 59125 cycles 1.00
ML-KEM-768 encaps 71831 cycles 71350 cycles 1.01
ML-KEM-768 decaps 89385 cycles 88994 cycles 1.00
ML-KEM-1024 keypair 87581 cycles 87405 cycles 1.00
ML-KEM-1024 encaps 104624 cycles 104569 cycles 1.00
ML-KEM-1024 decaps 127568 cycles 127540 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton3

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 18992 cycles 18992 cycles 1
ML-KEM-512 encaps 23578 cycles 23576 cycles 1.00
ML-KEM-512 decaps 30754 cycles 30756 cycles 1.00
ML-KEM-768 keypair 32248 cycles 32245 cycles 1.00
ML-KEM-768 encaps 35715 cycles 35711 cycles 1.00
ML-KEM-768 decaps 45881 cycles 45884 cycles 1.00
ML-KEM-1024 keypair 46845 cycles 46850 cycles 1.00
ML-KEM-1024 encaps 52632 cycles 52632 cycles 1
ML-KEM-1024 decaps 66479 cycles 66485 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Arm Cortex-A55 (Snapdragon 888) benchmarks

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 57912 cycles 57899 cycles 1.00
ML-KEM-512 encaps 65405 cycles 65166 cycles 1.00
ML-KEM-512 decaps 83799 cycles 83732 cycles 1.00
ML-KEM-768 keypair 98061 cycles 98151 cycles 1.00
ML-KEM-768 encaps 109994 cycles 109287 cycles 1.01
ML-KEM-768 decaps 135640 cycles 135972 cycles 1.00
ML-KEM-1024 keypair 149124 cycles 148983 cycles 1.00
ML-KEM-1024 encaps 165109 cycles 164799 cycles 1.00
ML-KEM-1024 decaps 201025 cycles 200051 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Intel Xeon 3rd gen (c6i) (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 56609 cycles 56586 cycles 1.00
ML-KEM-512 encaps 69473 cycles 69440 cycles 1.00
ML-KEM-512 decaps 91412 cycles 91359 cycles 1.00
ML-KEM-768 keypair 91892 cycles 91866 cycles 1.00
ML-KEM-768 encaps 107745 cycles 107989 cycles 1.00
ML-KEM-768 decaps 136404 cycles 136669 cycles 1.00
ML-KEM-1024 keypair 134755 cycles 134725 cycles 1.00
ML-KEM-1024 encaps 155213 cycles 155157 cycles 1.00
ML-KEM-1024 decaps 191518 cycles 191471 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton2

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 29196 cycles 29352 cycles 0.99
ML-KEM-512 encaps 35564 cycles 35772 cycles 0.99
ML-KEM-512 decaps 46111 cycles 46393 cycles 0.99
ML-KEM-768 keypair 49230 cycles 49233 cycles 1.00
ML-KEM-768 encaps 55400 cycles 55402 cycles 1.00
ML-KEM-768 decaps 70217 cycles 70216 cycles 1.00
ML-KEM-1024 keypair 72379 cycles 72350 cycles 1.00
ML-KEM-1024 encaps 81193 cycles 81160 cycles 1.00
ML-KEM-1024 decaps 100873 cycles 100832 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

AMD EPYC 4th gen (c7a) (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 45711 cycles 45752 cycles 1.00
ML-KEM-512 encaps 56856 cycles 56882 cycles 1.00
ML-KEM-512 decaps 76224 cycles 76277 cycles 1.00
ML-KEM-768 keypair 74482 cycles 74571 cycles 1.00
ML-KEM-768 encaps 88531 cycles 88687 cycles 1.00
ML-KEM-768 decaps 114346 cycles 114485 cycles 1.00
ML-KEM-1024 keypair 109358 cycles 109508 cycles 1.00
ML-KEM-1024 encaps 127208 cycles 127364 cycles 1.00
ML-KEM-1024 decaps 159882 cycles 160097 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

AMD EPYC 3rd gen (c6a) (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 52195 cycles 52176 cycles 1.00
ML-KEM-512 encaps 65734 cycles 65786 cycles 1.00
ML-KEM-512 decaps 88369 cycles 88405 cycles 1.00
ML-KEM-768 keypair 84719 cycles 84765 cycles 1.00
ML-KEM-768 encaps 101443 cycles 101493 cycles 1.00
ML-KEM-768 decaps 132042 cycles 132083 cycles 1.00
ML-KEM-1024 keypair 124052 cycles 124036 cycles 1.00
ML-KEM-1024 encaps 145724 cycles 145752 cycles 1.00
ML-KEM-1024 decaps 183666 cycles 183688 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton4 (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 41950 cycles 41988 cycles 1.00
ML-KEM-512 encaps 50165 cycles 50166 cycles 1.00
ML-KEM-512 decaps 66050 cycles 66055 cycles 1.00
ML-KEM-768 keypair 69050 cycles 69059 cycles 1.00
ML-KEM-768 encaps 79757 cycles 79763 cycles 1.00
ML-KEM-768 decaps 101014 cycles 101021 cycles 1.00
ML-KEM-1024 keypair 102203 cycles 102455 cycles 1.00
ML-KEM-1024 encaps 117201 cycles 117442 cycles 1.00
ML-KEM-1024 decaps 143669 cycles 143405 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton3 (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 45391 cycles 45381 cycles 1.00
ML-KEM-512 encaps 54219 cycles 54214 cycles 1.00
ML-KEM-512 decaps 71159 cycles 71149 cycles 1.00
ML-KEM-768 keypair 74828 cycles 74824 cycles 1.00
ML-KEM-768 encaps 86070 cycles 86057 cycles 1.00
ML-KEM-768 decaps 108812 cycles 108810 cycles 1.00
ML-KEM-1024 keypair 111125 cycles 111124 cycles 1.00
ML-KEM-1024 encaps 125933 cycles 125931 cycles 1.00
ML-KEM-1024 decaps 154624 cycles 154622 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Graviton2 (no-opt)

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 71251 cycles 71216 cycles 1.00
ML-KEM-512 encaps 85064 cycles 85028 cycles 1.00
ML-KEM-512 decaps 112739 cycles 112726 cycles 1.00
ML-KEM-768 keypair 117676 cycles 117136 cycles 1.00
ML-KEM-768 encaps 135334 cycles 135113 cycles 1.00
ML-KEM-768 decaps 171955 cycles 171807 cycles 1.00
ML-KEM-1024 keypair 175298 cycles 174626 cycles 1.00
ML-KEM-1024 encaps 197382 cycles 196727 cycles 1.00
ML-KEM-1024 decaps 243621 cycles 242770 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Bananapi bpi-f3 benchmarks

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 335053 cycles 335070 cycles 1.00
ML-KEM-512 encaps 445713 cycles 445597 cycles 1.00
ML-KEM-512 decaps 593801 cycles 593832 cycles 1.00
ML-KEM-768 keypair 556004 cycles 556188 cycles 1.00
ML-KEM-768 encaps 697746 cycles 698049 cycles 1.00
ML-KEM-768 decaps 889371 cycles 890329 cycles 1.00
ML-KEM-1024 keypair 821627 cycles 821283 cycles 1.00
ML-KEM-1024 encaps 998284 cycles 997945 cycles 1.00
ML-KEM-1024 decaps 1230464 cycles 1230396 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

@oqs-bot
Copy link

Choose a reason for hiding this comment

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

Arm Cortex-A72 (Raspberry Pi 4) benchmarks

Benchmark suite Current: e7721c6 Previous: 7938203 Ratio
ML-KEM-512 keypair 51602 cycles 52689 cycles 0.98
ML-KEM-512 encaps 58523 cycles 58752 cycles 1.00
ML-KEM-512 decaps 74439 cycles 75138 cycles 0.99
ML-KEM-768 keypair 87911 cycles 87133 cycles 1.01
ML-KEM-768 encaps 96588 cycles 95975 cycles 1.01
ML-KEM-768 decaps 118860 cycles 119479 cycles 0.99
ML-KEM-1024 keypair 132251 cycles 131910 cycles 1.00
ML-KEM-1024 encaps 145474 cycles 144449 cycles 1.01
ML-KEM-1024 decaps 175712 cycles 175735 cycles 1.00

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.