@@ -44,22 +44,34 @@ conda env create -n rapids --solver=libmamba -f envs/conda-env-rapids.yml
44
44
45
45
### Benchmarks Runner
46
46
47
- How to run benchmarks using the ` sklbench ` module and a specific configuration :
47
+ How to run sklearnex benchmarks on CPU using the ` sklbench ` module and regular scope of benchmarking cases :
48
48
49
49
``` bash
50
- python -m sklbench --config configs/sklearn_example.json
50
+ python -m sklbench --configs configs/regular \
51
+ --filters algorithm:library=sklearnex algorithm:device=cpu \
52
+ --environment-name ENV_NAME --result-file result_sklearnex_cpu_regular.json
53
+ # same command with shorter argument aliases for typing convenience
54
+ python -m sklbench -c configs/regular \
55
+ -f algorithm:library=sklearnex algorithm:device=cpu \
56
+ -e ENV_NAME -r result_sklearnex_cpu_regular.json
51
57
```
52
58
53
59
The default output is a file with JSON-formatted results of benchmarking cases. To generate a better human-readable report, use the following command:
54
60
55
61
``` bash
56
- python -m sklbench --config configs/sklearn_example.json --report
62
+ python -m sklbench -c configs/regular \
63
+ -f algorithm:library=sklearnex algorithm:device=cpu \
64
+ -e ENV_NAME -r result_sklearnex_cpu_regular.json \
65
+ --report --report-file result-sklearnex-cpu-regular.xlsx
57
66
```
58
67
59
- By default, output and report file paths are ` result.json ` and ` report.xlsx ` . To specify custom file paths, run:
60
-
68
+ In order to optimize datasets downloading and get more verbose output, use ` --prefetch-datasets ` and ` -l INFO ` arguments:
61
69
``` bash
62
- python -m sklbench --config configs/sklearn_example.json --report --result-file result_example.json --report-file report_example.xlsx
70
+ python -m sklbench -c configs/regular \
71
+ -f algorithm:library=sklearnex algorithm:device=cpu \
72
+ -e ENV_NAME -r result_sklearnex_cpu_regular.json \
73
+ --report --report-file report-sklearnex-cpu-regular.xlsx \
74
+ --prefetch-datasets -l INFO
63
75
```
64
76
65
77
For a description of all benchmarks runner arguments, refer to [ documentation] ( sklbench/runner/README.md#arguments ) .
@@ -69,7 +81,9 @@ For a description of all benchmarks runner arguments, refer to [documentation](s
69
81
To combine raw result files gathered from different environments, call the report generator:
70
82
71
83
``` bash
72
- python -m sklbench.report --result-files result_1.json result_2.json --report-file report_example.xlsx
84
+ python -m sklbench.report \
85
+ --result-files result_1.json result_2.json \
86
+ --report-file report_example.xlsx
73
87
```
74
88
75
89
For a description of all report generator arguments, refer to [ documentation] ( sklbench/report/README.md#arguments ) .
0 commit comments