Skip to content

Commit 133f11e

Browse files
committed
Adding input policy to readme
1 parent 783b729 commit 133f11e

File tree

1 file changed

+37
-22
lines changed

1 file changed

+37
-22
lines changed

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,10 @@ SPDX-License-Identifier: Apache-2.0
4949
conda env create -n dpbench -f ./environments/conda.yml
5050
```
5151

52-
- SYCL
53-
54-
If you want to build sycl benchmarks as well:
55-
```bash
56-
conda env create -n dpbench -f ./environments/conda-linux-sycl.yml
57-
CC=icx CXX=icpx DPBENCH_SYCL=1 pip install --no-index --no-deps --no-build-isolation -e . -v
58-
```
52+
If you want to build sycl benchmarks as well:
53+
```bash
54+
conda env create -n dpbench -f ./environments/conda-linux-sycl.yml
55+
```
5956

6057
3. Build DPBench
6158

@@ -69,18 +66,16 @@ SPDX-License-Identifier: Apache-2.0
6966
python setup.py develop
7067
```
7168

72-
- SYCL
73-
74-
For sycl build use:
75-
```bash
76-
CC=icx CXX=icpx DPBENCH_SYCL=1 pip install --no-index --no-deps --no-build-isolation -e . -v
77-
```
69+
For sycl build use:
70+
```bash
71+
CC=icx CXX=icpx DPBENCH_SYCL=1 pip install --no-index --no-deps --no-build-isolation -e . -v
72+
```
7873

79-
or
74+
or
8075

81-
```bash
82-
CC=icx CXX=icpx DPBENCH_SYCL=1 python setup.py develop
83-
```
76+
```bash
77+
CC=icx CXX=icpx DPBENCH_SYCL=1 python setup.py develop
78+
```
8479

8580
4. Run specific benchmark, e.g. black_scholes
8681

@@ -104,11 +99,14 @@ SPDX-License-Identifier: Apache-2.0
10499

105100
3. Device Customization
106101

107-
If a framework is SYCL based, an extra configuration option `sycl_device` may be set in the
108-
framework config file or by passing `--sycl-device` argument to `dpbench run` to control what device the framework uses for execution. The `sycl_device`
109-
value should be a legal
110-
[SYCL device filter ](https://intel.github.io/llvm-docs/EnvironmentVariables.html#sycl_device_filter)
111-
string. The dpcpp, dpnp, and numba_dpex frameworks support the sycl_device option.
102+
If a framework is SYCL based, an extra configuration option
103+
`sycl_device` may be set in the framework config file or by passing
104+
`--sycl-device` argument to `dpbench run` to control what device
105+
the framework uses for execution. The `sycl_device` value should be
106+
a legal [SYCL device filter
107+
](https://intel.github.io/llvm-docs/EnvironmentVariables.html#sycl_device_filter)
108+
string. The dpcpp, dpnp, and numba_dpex frameworks support the
109+
sycl_device option.
112110

113111
Here is an example:
114112

@@ -190,3 +188,20 @@ SPDX-License-Identifier: Apache-2.0
190188
--csv
191189
Sets the general summary report to output in CSV format (default: False)
192190
```
191+
192+
### Performance Measurement
193+
194+
For each benchmark, we measure the execution time of the
195+
computationally intesive part, but not the intialization or
196+
shutdown. We provide three inputs (a.k.a presets) for each benchmark.
197+
198+
* **S** - Minimal input to verify that programs are executable
199+
* **M** - Medium-sized input for performance measurements on client devices
200+
* **L** - Large-sized input for performance measurements on servers
201+
202+
As a rough guideline for selecting input sizes, **S** inputs need to
203+
be small enough for python and numpy implementations to execute in
204+
<100ms. **M** and **L** inputs need to be large enough to obtain
205+
useful performance insights on client and servers devices,
206+
respectively. Also, note that the python and numpy implementations are
207+
not expected to work with **M** and **L** inputs.

0 commit comments

Comments
 (0)