Skip to content
Snippets Groups Projects

Revert "Update CLI.rst"

Merged Adriano Garcia requested to merge revert-813e1809 into master
1 file
+ 63
63
Compare changes
  • Side-by-side
  • Inline
+ 63
63
@@ -216,76 +216,76 @@ Exec
- ``-nthreads <number_of_threads>``
Number of threads. It can be used inside the benchmarks as a global variable. You can insert a single number or a range using the ':' character (e.g. ``-nthreads 1:10``). You can also define iteration step of the range (e.g. ``-nthreads 4:4:16`` would run the benchmarks with 4, 8, 12, and 16 threads). Default value: 1.
- ``-batch <batch_size>``
It can be used to change the batch size (default: 1).
- ``-batch-interval <time_interval_sec>``
It can be used to change the batch time interval. Default = 0 (disabled).
- ``-frequency <items_per_second>``
A limited number of items will be available for the source per second.
By default, no limit is aplied, which is equivalent to maximum frequency.
The maximum frequency is defined by your system's memory or disk access speed.
- ``-freq-pattern <frequency_pattern>``
(pattern,period,max,min).
This argument overwrites the -frequency command and sets a varying frequency for the input stream.
For this argument users need to supply a tuple string: <pattern,period,max,min>, where pattern can be "wave", "spike", "binary", "increasing" or "decreasing".
Period is the duration in seconds of one cycle of the pattern.
And min is the minimum frequency and max the maximum frequency, defined in items per second.
For the spike pattern users can also set the duration of the spikes as percentage of the period (0-100) (e.g. <pattern,period,max,min,spike>).
The default spike duration is 10 percent of the period.
Usage example: ``-freq-pattern wave,10,5,80``
- ``-in-memory``
It runs the application in in-memory mode.
- ``-latency``
Print average latency results at the end of the execution.
- ``-throughput``
Print the average throughput at the end of the execution.
- ``-resource-usage``
It prints the global memory and CPU usage at the end of the execution.
To use it is required to run the benchmark as root or adjust paranoid value.
- ``-monitor <time_interval>`` (millisecond)
Use this option to monitor latency, throughput, CPU and memory usage.
You must indicate a monitoring time interval in milliseconds (e.g. 250).
- ``-monitor-thread <time_interval>`` (millisecond)
Use this option to monitor latency, throughput, CPU and memory usage.
It works the same as the ``-monitor`` command above, but it runs the monitoring computations in an individual thread.
It may be used for decreased performance overhead in the application when monitoring with low time intervals.
- ``-latency-monitor``
It monitors latency per stage and per item and generates a log file.
- ``-batch <batch_size>``
It can be used to change the batch size (default: 1).
- ``-batch-interval <time_interval_sec>``
It can be used to change the batch time interval. Default = 0 (disabled).
- ``-frequency <items_per_second>``
A limited number of items will be available for the source per second.
By default, no limit is aplied, which is equivalent to maximum frequency.
The maximum frequency is defined by your system's memory or disk access speed.
- ``-freq-pattern <frequency_pattern>``
(pattern,period,max,min).
This argument overwrites the -frequency command and sets a varying frequency for the input stream.
For this argument users need to supply a tuple string: <pattern,period,max,min>, where pattern can be "wave", "spike", "binary", "increasing" or "decreasing".
Period is the duration in seconds of one cycle of the pattern.
And min is the minimum frequency and max the maximum frequency, defined in items per second.
For the spike pattern users can also set the duration of the spikes as percentage of the period (0-100) (e.g. <pattern,period,max,min,spike>).
The default spike duration is 10 percent of the period.
Usage example: ``-freq-pattern wave,10,5,80``
- ``-in-memory``
It runs the application in in-memory mode.
- ``-latency``
Print average latency results at the end of the execution.
- ``-throughput``
Print the average throughput at the end of the execution.
- ``-resource-usage``
It prints the global memory and CPU usage at the end of the execution.
To use it is required to run the benchmark as root or adjust paranoid value.
- ``-monitor <time_interval>`` (millisecond)
Use this option to monitor latency, throughput, CPU and memory usage.
You must indicate a monitoring time interval in milliseconds (e.g. 250).
- ``-monitor-thread <time_interval>`` (millisecond)
Use this option to monitor latency, throughput, CPU and memory usage.
It works the same as the ``-monitor`` command above, but it runs the monitoring computations in an individual thread.
It may be used for decreased performance overhead in the application when monitoring with low time intervals.
- ``-latency-monitor``
It monitors latency per stage and per item and generates a log file.
- ``-user-arg <user_custom_argument>``
User custom argument. Allow users to pass one or more arguments to use inside the benchmarks.
Single argument: [-user-arg single_argument] or [-user-arg "single argument"].
Multiple arguments: [-user-arg two arguments] or [-user-arg two -user-args arguments].
- ``-user-arg <user_custom_argument>``
User custom argument. Allow users to pass one or more arguments to use inside the benchmarks.
Single argument: [-user-arg single_argument] or [-user-arg "single argument"].
Multiple arguments: [-user-arg two arguments] or [-user-arg two -user-args arguments].
- ``-test-result``
This option will run a correctness test on the output (when available) after the benchmark execution.
- ``-test-result``
This option will run a correctness test on the output (when available) after the benchmark execution.
- ``-repeat <number_of_repetitions>``
Use this argument to repeat this execution n times. It will compute and show a summary of the selected metrics at the end.
- ``-repeat <number_of_repetitions>``
Use this argument to repeat this execution n times. It will compute and show a summary of the selected metrics at the end.
- ``-print``
When this parameter is added, the exec command will only print on the screen the execution command it would use to run the benchmark.
You may use it to manually change some specific aspect of the execution that is not supported by SPBench.
- ``-print``
When this parameter is added, the exec command will only print on the screen the execution command it would use to run the benchmark.
You may use it to manually change some specific aspect of the execution that is not supported by SPBench.
- ``-quiet``
Run it in quiet mode. If any metrics are selected, it shows the results in a short format.
- ``-quiet``
Run it in quiet mode. If any metrics are selected, it shows the results in a short format.
- ``executor <executor_name_and_parameters>``
You can use this argument to change the way the benchmarks are executed.
Usage example: ``./spbench exec -executor "-my_executor my_executor_parameters" -bench ...``
- ``executor <executor_name_and_parameters>``
You can use this argument to change the way the benchmarks are executed.
Usage example: ``./spbench exec -executor "-my_executor my_executor_parameters" -bench ...``
- ``-d`` (Bzip2 only)
Enables decompress mode for Bzip2 benchmarks.
- ``-d`` (Bzip2 only)
Enables decompress mode for Bzip2 benchmarks.
**Usage example:**
Loading