djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tests/README: Document ./run-internalbench.py.

Browse Source 
Signed-off-by: Angus Gratton <angus@redyak.com.au>
This commit is contained in:
Angus Gratton 2023-09-20 18:11:51 +10:00 committed by Damien George
parent 3c2b2f7a4d
commit dd8a69b5f2
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tests/README.md
View File

@ -147,3 +147,30 @@ the test runs, and the absolute difference value is unreliable. High error
percentages are particularly common on PC builds, where the host OS may
influence test run times. Increasing the `N` value may help average this out by
running each test longer.
## internal_bench
The `internal_bench` directory contains a set of tests for benchmarking
different internal Python features. By default, tests are run on the (unix or
Windows) host, but the `--pyboard` option allows them to be run on an attached
board instead.
Tests are grouped by the first part of the file name, and the test runner compares
output between each group of tests.
The benchmarks measure the elapsed (wall time) for each test, according
to MicroPython's own time module.
If run without any arguments, all test groups are run. Otherwise, it's possible
to manually specify which test cases to run.
Example:
```
$ ./run-internalbench.py internal_bench/bytebuf-*.py
internal_bench/bytebuf:
0.094s (+00.00%) internal_bench/bytebuf-1-inplace.py
0.471s (+399.24%) internal_bench/bytebuf-2-join_map_bytes.py
0.177s (+87.78%) internal_bench/bytebuf-3-bytarray_map.py
1 tests performed (3 individual testcases)
```