Merge pull request #2379 from terrelln/regression-test

[regression] Updates results.csv & add README
This commit is contained in:
Nick Terrell 2020-10-30 15:09:38 -07:00 committed by GitHub
commit 37d546c445
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 6 deletions

View File

@ -0,0 +1,28 @@
# Regression tests
The regression tests run zstd in many scenarios and ensures that the size of the compressed results doesn't change. This helps us ensure that we don't accidentally regress zstd's compression ratio.
These tests get run every night by CircleCI. If the job fails you can read the diff printed by the job to ensure the change isn't a regression. If all is well you can download the `results.csv` artifact and commit the new results. Or you can rebuild it yourself following the instructions below.
## Rebuilding results.csv
From the root of the zstd repo run:
```
# Build the zstd binary
make clean
make -j zstd
# Build the regression test binary
cd tests/regression
make clean
make -j test
# Run the regression test
./test --cache data-cache --zstd ../../zstd --output results.csv
# Check results.csv to ensure the new results are okay
git diff
# Then submit the PR
```

View File

@ -212,8 +212,8 @@ silesia.tar, level 16, advanced
silesia.tar, level 19, advanced one pass, 4281605
silesia.tar, no source size, advanced one pass, 4861425
silesia.tar, long distance mode, advanced one pass, 4848098
silesia.tar, multithreaded, advanced one pass, 4860781
silesia.tar, multithreaded long distance mode, advanced one pass, 4847398
silesia.tar, multithreaded, advanced one pass, 4861508
silesia.tar, multithreaded long distance mode, advanced one pass, 4853186
silesia.tar, small window log, advanced one pass, 7101530
silesia.tar, small hash log, advanced one pass, 6587951
silesia.tar, small chain log, advanced one pass, 4943307
@ -221,7 +221,7 @@ silesia.tar, explicit params, advanced
silesia.tar, uncompressed literals, advanced one pass, 5129458
silesia.tar, uncompressed literals optimal, advanced one pass, 4320927
silesia.tar, huffman literals, advanced one pass, 5347335
silesia.tar, multithreaded with advanced params, advanced one pass, 5129777
silesia.tar, multithreaded with advanced params, advanced one pass, 5129555
github, level -5, advanced one pass, 205285
github, level -5 with dict, advanced one pass, 46718
github, level -3, advanced one pass, 190643
@ -304,8 +304,8 @@ silesia.tar, level 16, advanced
silesia.tar, level 19, advanced one pass small out, 4281605
silesia.tar, no source size, advanced one pass small out, 4861425
silesia.tar, long distance mode, advanced one pass small out, 4848098
silesia.tar, multithreaded, advanced one pass small out, 4860781
silesia.tar, multithreaded long distance mode, advanced one pass small out, 4847398
silesia.tar, multithreaded, advanced one pass small out, 4861508
silesia.tar, multithreaded long distance mode, advanced one pass small out, 4853186
silesia.tar, small window log, advanced one pass small out, 7101530
silesia.tar, small hash log, advanced one pass small out, 6587951
silesia.tar, small chain log, advanced one pass small out, 4943307
@ -313,7 +313,7 @@ silesia.tar, explicit params, advanced
silesia.tar, uncompressed literals, advanced one pass small out, 5129458
silesia.tar, uncompressed literals optimal, advanced one pass small out, 4320927
silesia.tar, huffman literals, advanced one pass small out, 5347335
silesia.tar, multithreaded with advanced params, advanced one pass small out, 5129777
silesia.tar, multithreaded with advanced params, advanced one pass small out, 5129555
github, level -5, advanced one pass small out, 205285
github, level -5 with dict, advanced one pass small out, 46718
github, level -3, advanced one pass small out, 190643

1 Data Config Method Total compressed size
212 silesia.tar level 19 advanced one pass 4281605
213 silesia.tar no source size advanced one pass 4861425
214 silesia.tar long distance mode advanced one pass 4848098
215 silesia.tar multithreaded advanced one pass 4860781 4861508
216 silesia.tar multithreaded long distance mode advanced one pass 4847398 4853186
217 silesia.tar small window log advanced one pass 7101530
218 silesia.tar small hash log advanced one pass 6587951
219 silesia.tar small chain log advanced one pass 4943307
221 silesia.tar uncompressed literals advanced one pass 5129458
222 silesia.tar uncompressed literals optimal advanced one pass 4320927
223 silesia.tar huffman literals advanced one pass 5347335
224 silesia.tar multithreaded with advanced params advanced one pass 5129777 5129555
225 github level -5 advanced one pass 205285
226 github level -5 with dict advanced one pass 46718
227 github level -3 advanced one pass 190643
304 silesia.tar level 19 advanced one pass small out 4281605
305 silesia.tar no source size advanced one pass small out 4861425
306 silesia.tar long distance mode advanced one pass small out 4848098
307 silesia.tar multithreaded advanced one pass small out 4860781 4861508
308 silesia.tar multithreaded long distance mode advanced one pass small out 4847398 4853186
309 silesia.tar small window log advanced one pass small out 7101530
310 silesia.tar small hash log advanced one pass small out 6587951
311 silesia.tar small chain log advanced one pass small out 4943307
313 silesia.tar uncompressed literals advanced one pass small out 5129458
314 silesia.tar uncompressed literals optimal advanced one pass small out 4320927
315 silesia.tar huffman literals advanced one pass small out 5347335
316 silesia.tar multithreaded with advanced params advanced one pass small out 5129777 5129555
317 github level -5 advanced one pass small out 205285
318 github level -5 with dict advanced one pass small out 46718
319 github level -3 advanced one pass small out 190643