Add contributing documentation for stefc

[tigrannajaryan]

No description provided.

[github-actions]

Benchmark Result

Benchmark diff with base branch

goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │     sec/op     │    sec/op     vs base              │
SerializeNative/STEF/serialize-4                     6.948m ± 10%   6.807m ±  4%       ~ (p=0.394 n=6)
SerializeNative/STEFU/serialize-4                    33.63m ±  2%   33.77m ±  2%       ~ (p=0.240 n=6)
DeserializeNative/STEF/deser-4                       2.442m ±  7%   2.447m ±  1%       ~ (p=1.000 n=6)
DeserializeNative/STEFU/deser-4                      7.461m ±  1%   7.435m ±  0%       ~ (p=0.394 n=6)
SerializeFromPdata/STEF/serialize-4                  134.3m ±  3%   134.9m ±  3%       ~ (p=0.818 n=6)
SerializeFromPdata/STEFU/serialize-4                 34.41m ±  2%   34.24m ±  1%       ~ (p=0.093 n=6)
DeserializeToPdata/STEF/deserialize-4                44.91m ±  2%   45.34m ±  2%       ~ (p=0.589 n=6)
DeserializeToPdata/STEFU/deserialize-4               62.61m ±  1%   62.55m ±  1%       ~ (p=0.818 n=6)
STEFReaderRead-4                                     2.513m ±  1%   2.502m ±  1%       ~ (p=0.310 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4        3.264 ± 24%    3.238 ± 24%       ~ (p=1.000 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     76.44m ± 10%   75.18m ± 12%       ~ (p=0.485 n=6)
ReadSTEF-4                                           2.496m ±  3%   2.574m ±  2%  +3.13% (p=0.041 n=6)
ReadSTEFZ-4                                          3.092m ±  1%   3.272m ±  1%  +5.82% (p=0.002 n=6)
ReadSTEFZWriteSTEF-4                                 7.241m ±  2%   7.917m ±  2%  +9.34% (p=0.002 n=6)
geomean                                              20.24m         20.44m        +0.99%

                                                 │ bench-main.txt │           bench-new.txt            │
                                                 │   sec/point    │  sec/point    vs base              │
SerializeNative/STEF/serialize-4                     103.9n ± 10%   101.8n ±  4%       ~ (p=0.394 n=6)
SerializeNative/STEFU/serialize-4                    503.0n ±  2%   505.1n ±  2%       ~ (p=0.197 n=6)
DeserializeNative/STEF/deser-4                       36.52n ±  7%   36.60n ±  1%       ~ (p=1.000 n=6)
DeserializeNative/STEFU/deser-4                      111.7n ±  1%   111.2n ±  0%       ~ (p=0.385 n=6)
SerializeFromPdata/STEF/serialize-4                  2.008µ ±  2%   2.017µ ±  3%       ~ (p=0.818 n=6)
SerializeFromPdata/STEFU/serialize-4                 514.8n ±  2%   512.1n ±  1%       ~ (p=0.093 n=6)
DeserializeToPdata/STEF/deserialize-4                671.8n ±  2%   678.3n ±  2%       ~ (p=0.589 n=6)
DeserializeToPdata/STEFU/deserialize-4               936.5n ±  1%   935.7n ±  1%       ~ (p=0.784 n=6)
STEFReaderRead-4                                     37.59n ±  1%   37.43n ±  1%       ~ (p=0.288 n=6)
STEFSerializeMultipart/astronomy-otelmetrics-4       4.149µ ± 24%   4.116µ ± 24%       ~ (p=1.000 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     97.17n ± 10%   95.56n ± 12%       ~ (p=0.485 n=6)
ReadSTEF-4                                           37.36n ±  3%   38.52n ±  2%  +3.13% (p=0.041 n=6)
ReadSTEFZ-4                                          46.28n ±  1%   48.97n ±  1%  +5.81% (p=0.002 n=6)
ReadSTEFZWriteSTEF-4                                 108.4n ±  2%   118.5n ±  2%  +9.32% (p=0.002 n=6)
geomean                                              212.9n         215.0n        +0.98%

                                                 │ bench-main.txt │            bench-new.txt             │
                                                 │      B/op      │     B/op      vs base                │
SerializeNative/STEF/serialize-4                     3.339Mi ± 0%   3.339Mi ± 0%       ~ (p=0.937 n=6)
SerializeNative/STEFU/serialize-4                    7.530Mi ± 0%   7.530Mi ± 0%       ~ (p=0.158 n=6)
DeserializeNative/STEF/deser-4                       934.4Ki ± 0%   934.4Ki ± 0%       ~ (p=1.000 n=6) ¹
DeserializeNative/STEFU/deser-4                      1.471Mi ± 0%   1.471Mi ± 0%       ~ (p=0.182 n=6)
SerializeFromPdata/STEF/serialize-4                  74.82Mi ± 0%   74.82Mi ± 0%       ~ (p=0.621 n=6)
SerializeFromPdata/STEFU/serialize-4                 7.530Mi ± 0%   7.530Mi ± 0%       ~ (p=0.392 n=6)
DeserializeToPdata/STEF/deserialize-4                31.97Mi ± 0%   31.97Mi ± 0%       ~ (p=0.348 n=6)
DeserializeToPdata/STEFU/deserialize-4               38.64Mi ± 0%   38.64Mi ± 0%       ~ (p=0.911 n=6)
STEFReaderRead-4                                     936.2Ki ± 0%   936.2Ki ± 0%       ~ (p=1.000 n=6) ¹
STEFSerializeMultipart/astronomy-otelmetrics-4       3.361Gi ± 0%   3.363Gi ± 0%       ~ (p=0.589 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4     20.41Mi ± 0%   20.41Mi ± 0%       ~ (p=0.978 n=6)
ReadSTEF-4                                           936.2Ki ± 0%   936.2Ki ± 0%       ~ (p=0.147 n=6)
ReadSTEFZ-4                                          10.27Mi ± 0%   10.27Mi ± 0%  -0.00% (p=0.002 n=6)
ReadSTEFZWriteSTEF-4                                 13.43Mi ± 0%   13.43Mi ± 0%       ~ (p=0.662 n=6)
geomean                                              10.47Mi        10.47Mi       +0.00%
¹ all samples are equal

                                                 │ bench-main.txt │            bench-new.txt            │
                                                 │   allocs/op    │  allocs/op   vs base                │
SerializeNative/STEF/serialize-4                      2.647k ± 0%   2.646k ± 0%       ~ (p=0.851 n=6)
SerializeNative/STEFU/serialize-4                      884.0 ± 0%    884.0 ± 0%       ~ (p=1.000 n=6)
DeserializeNative/STEF/deser-4                         465.0 ± 0%    465.0 ± 0%       ~ (p=1.000 n=6) ¹
DeserializeNative/STEFU/deser-4                        469.0 ± 0%    469.0 ± 0%       ~ (p=1.000 n=6) ¹
SerializeFromPdata/STEF/serialize-4                   134.7k ± 0%   134.7k ± 0%       ~ (p=0.420 n=6)
SerializeFromPdata/STEFU/serialize-4                   886.0 ± 0%    886.0 ± 0%       ~ (p=1.000 n=6)
DeserializeToPdata/STEF/deserialize-4                 756.2k ± 0%   756.2k ± 0%       ~ (p=1.000 n=6) ¹
DeserializeToPdata/STEFU/deserialize-4                944.9k ± 0%   944.9k ± 0%       ~ (p=1.000 n=6) ¹
STEFReaderRead-4                                       465.0 ± 0%    465.0 ± 0%       ~ (p=1.000 n=6) ¹
STEFSerializeMultipart/astronomy-otelmetrics-4        13.15M ± 0%   13.15M ± 0%       ~ (p=0.524 n=6)
STEFDeserializeMultipart/astronomy-otelmetrics-4      2.294k ± 0%   2.294k ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEF-4                                             466.0 ± 0%    466.0 ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZ-4                                            503.0 ± 0%    503.0 ± 0%       ~ (p=1.000 n=6) ¹
ReadSTEFZWriteSTEF-4                                  1.233k ± 0%   1.233k ± 0%       ~ (p=1.000 n=6)
geomean                                               6.358k        6.358k       -0.00%
¹ all samples are equal

Benchmark result

benchstat bench-new.txt
goos: linux
goarch: amd64
pkg: github.com/splunk/stef/benchmarks
cpu: AMD EPYC 7763 64-Core Processor                
                                                 │ bench-new.txt │
                                                 │    sec/op     │
SerializeNative/STEF/serialize-4                    6.807m ±  4%
SerializeNative/STEFU/serialize-4                   33.77m ±  2%
DeserializeNative/STEF/deser-4                      2.447m ±  1%
DeserializeNative/STEFU/deser-4                     7.435m ±  0%
SerializeFromPdata/STEF/serialize-4                 134.9m ±  3%
SerializeFromPdata/STEFU/serialize-4                34.24m ±  1%
DeserializeToPdata/STEF/deserialize-4               45.34m ±  2%
DeserializeToPdata/STEFU/deserialize-4              62.55m ±  1%
STEFReaderRead-4                                    2.502m ±  1%
STEFSerializeMultipart/astronomy-otelmetrics-4       3.238 ± 24%
STEFDeserializeMultipart/astronomy-otelmetrics-4    75.18m ± 12%
ReadSTEF-4                                          2.574m ±  2%
ReadSTEFZ-4                                         3.272m ±  1%
ReadSTEFZWriteSTEF-4                                7.917m ±  2%
geomean                                             20.44m

                                                 │ bench-new.txt │
                                                 │   sec/point   │
SerializeNative/STEF/serialize-4                    101.8n ±  4%
SerializeNative/STEFU/serialize-4                   505.1n ±  2%
DeserializeNative/STEF/deser-4                      36.60n ±  1%
DeserializeNative/STEFU/deser-4                     111.2n ±  0%
SerializeFromPdata/STEF/serialize-4                 2.017µ ±  3%
SerializeFromPdata/STEFU/serialize-4                512.1n ±  1%
DeserializeToPdata/STEF/deserialize-4               678.3n ±  2%
DeserializeToPdata/STEFU/deserialize-4              935.7n ±  1%
STEFReaderRead-4                                    37.43n ±  1%
STEFSerializeMultipart/astronomy-otelmetrics-4      4.116µ ± 24%
STEFDeserializeMultipart/astronomy-otelmetrics-4    95.56n ± 12%
ReadSTEF-4                                          38.52n ±  2%
ReadSTEFZ-4                                         48.97n ±  1%
ReadSTEFZWriteSTEF-4                                118.5n ±  2%
geomean                                             215.0n

                                                 │ bench-new.txt │
                                                 │     B/op      │
SerializeNative/STEF/serialize-4                    3.339Mi ± 0%
SerializeNative/STEFU/serialize-4                   7.530Mi ± 0%
DeserializeNative/STEF/deser-4                      934.4Ki ± 0%
DeserializeNative/STEFU/deser-4                     1.471Mi ± 0%
SerializeFromPdata/STEF/serialize-4                 74.82Mi ± 0%
SerializeFromPdata/STEFU/serialize-4                7.530Mi ± 0%
DeserializeToPdata/STEF/deserialize-4               31.97Mi ± 0%
DeserializeToPdata/STEFU/deserialize-4              38.64Mi ± 0%
STEFReaderRead-4                                    936.2Ki ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4      3.363Gi ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4    20.41Mi ± 0%
ReadSTEF-4                                          936.2Ki ± 0%
ReadSTEFZ-4                                         10.27Mi ± 0%
ReadSTEFZWriteSTEF-4                                13.43Mi ± 0%
geomean                                             10.47Mi

                                                 │ bench-new.txt │
                                                 │   allocs/op   │
SerializeNative/STEF/serialize-4                     2.646k ± 0%
SerializeNative/STEFU/serialize-4                     884.0 ± 0%
DeserializeNative/STEF/deser-4                        465.0 ± 0%
DeserializeNative/STEFU/deser-4                       469.0 ± 0%
SerializeFromPdata/STEF/serialize-4                  134.7k ± 0%
SerializeFromPdata/STEFU/serialize-4                  886.0 ± 0%
DeserializeToPdata/STEF/deserialize-4                756.2k ± 0%
DeserializeToPdata/STEFU/deserialize-4               944.9k ± 0%
STEFReaderRead-4                                      465.0 ± 0%
STEFSerializeMultipart/astronomy-otelmetrics-4       13.15M ± 0%
STEFDeserializeMultipart/astronomy-otelmetrics-4     2.294k ± 0%
ReadSTEF-4                                            466.0 ± 0%
ReadSTEFZ-4                                           503.0 ± 0%
ReadSTEFZWriteSTEF-4                                 1.233k ± 0%
geomean                                              6.358k