Update README.md

lhc/simpletrack/README.md

@@ -24,10 +24,15 @@ Default entrypoint accepts the following environment for benchmark execution:
 | __DEVICE__    | "0.0"    | Platform ID         |
 | __BENCHMARK__ | ""       | Enable specific benchmark mode with "all", "device" | 
 
-Docker example:
+The following Docker examples demonstrate how to customise running setup. The benchmark mode allows to generate logs and output files in a default location (/simpletrack/examples/lhc/jobs or $CI_PROJECT_DIR) for either a single or all available devices.
 
 ```
 ~$ docker run --rm -e PARTICLES=100 -e TURNS=5 -e DEVICE="1.0" <image:tag>
+
+~$ docker run --rm -e DEVICE="1.0" -e BENCHMARK="device" <image:tag>
+
+~$ docker run --rm -e BENCHMARK="all" <image:tag>
+
 ```
 
 ## Target Platform
@@ -36,7 +41,7 @@ To discover and target available platform pass the desired DEVICE environment va
 
 ```
 ~$ docker run --rm --device /dev/dri:/dev/dri --entrypoint="/bin/bash" \
-   gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-0.1.0 \
+   gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-latest \
    -c "cd /simpletrack/examples/lhc && python3 benchmark_opencl.py --show"
 
 Platform : Intel(R) OpenCL HD Graphics
@@ -44,11 +49,11 @@ Platform : Intel(R) OpenCL HD Graphics
 Platform : Intel(R) OpenCL
   Device '1.0': Intel(R) Core(TM) i5-6200U CPU @ 2.30GHz
 
-~$ docker run --rm --device /dev/dri:/dev/dri -e DEVICE "0.0" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-0.1.0
+~$ docker run --rm --device /dev/dri:/dev/dri -e DEVICE "0.0" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-latest
 
 29820 particles*turns/seconds, 20000 particles, 15 turns, device '0.0', Intel(R) Gen9 HD Graphics NEO
 
-~$ docker run --rm --device /dev/dri:/dev/dri -e DEVICE "1.0" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-0.1.0
+~$ docker run --rm --device /dev/dri:/dev/dri -e DEVICE "1.0" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-latest
 
 5856 particles*turns/seconds, 20000 particles, 15 turns, device '1.0', Intel(R) Core(TM) i5-6200U CPU @ 2.30GHz
 ```
@@ -56,7 +61,7 @@ Platform : Intel(R) OpenCL
 For a full list of available platforms use _clinfo_ tool as follows:
 
 ```
-~$ docker run --rm --entrypoint "/usr/bin/clinfo" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-0.1.0
+~$ docker run --rm --entrypoint "/usr/bin/clinfo" gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-latest
 ```
 
 ## Docker Passthrough
@@ -64,7 +69,7 @@ For a full list of available platforms use _clinfo_ tool as follows:
 To enable GPU passthrough use "--gpus all" or "--device /dev/dri:/dev/dri" for Nvidia and Intel targets as follows:
 
 ```
-~$ docker run --rm --gpus all gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:nvidia-0.1.0
+~$ docker run --rm --gpus all gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:nvidia-latest
 
-~$ docker run --rm --device /dev/dri:/dev/dri gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-0.1.0
+~$ docker run --rm --device /dev/dri:/dev/dri gitlab-registry.cern.ch/hep-benchmarks/hep-workloads-gpu/lhc/simpletrack:intel-latest
 ```