You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration-options.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,26 +22,25 @@ benchmark {
22
22
23
23
Configuration profiles dictate the execution pattern of benchmarks:
24
24
25
-
- Utilize `include` and `exclude` options to select specific benchmarks for a profile.
26
-
- By default, every benchmark is included.
25
+
- Utilize `include` and `exclude` options to select specific benchmarks for a profile. By default, every benchmark is included.
27
26
- Each configuration profile translates to a task in the `kotlinx-benchmark` Gradle plugin. For instance, the task `smokeBenchmark` is tailored to run benchmarks based on the `"smoke"` configuration profile. For an overview of tasks, refer to [tasks-overview.md](tasks-overview.md).
28
27
29
28
## Core Configuration Options
30
29
31
30
Note that values defined in the build script take precedence over those specified by annotations in the code.
|`iterations`| Sets the number of iterations for measurements. |Integer |@Measurement(iterations: Int, ...) |
36
-
|`warmups`| Sets the number of iterations for system warming, ensuring accurate measurements. |Integer |@Warmup(iterations: Int) |
37
-
|`iterationTime`| Sets the duration for each iteration, both measurement and warm-up. |Integer |@Measurement(..., time: Int, ...) |
38
-
|`iterationTimeUnit`| Defines the unit for `iterationTime`. | Time unit, see below |@Measurement(..., timeUnit: BenchmarkTimeUnit, ...) |
39
-
|`outputTimeUnit`| Sets the unit for the results display. | Time unit, see below |@OutputTimeUnit(value: BenchmarkTimeUnit) |
40
-
|`mode`| Selects "thrpt" (Throughput) for measuring the number of function calls per unit time or "avgt" (AverageTime) for measuring the time per function call. |`thrpt`(default), `Throughput`(default), `avgt`, `AverageTime`|@BenchmarkMode|
41
-
|`include("…")`| Applies a regular expression to include benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
42
-
|`exclude("…")`| Applies a regular expression to exclude benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
43
-
|`param("name", "value1", "value2")`| Assigns values to a public mutable property with the specified name, annotated with `@Param`. | Any string values|@Param|
44
-
|`reportFormat`| Defines the benchmark report's format options. |`json`(default), `csv`, `scsv`, `text`| - |
32
+
| Option | Description | Possible Values| Corresponding Annotation |
|`iterations`| Sets the number of iterations for measurements. | Positive Integer|@Measurement(iterations: Int, ...) |
35
+
|`warmups`| Sets the number of iterations for system warming, ensuring accurate measurements. | Non-negative Integer|@Warmup(iterations: Int) |
36
+
|`iterationTime`| Sets the duration for each iteration, both measurement and warm-up. | Positive Integer|@Measurement(..., time: Int, ...) |
37
+
|`iterationTimeUnit`| Defines the unit for `iterationTime`. | Time unit, see below|@Measurement(..., timeUnit: BenchmarkTimeUnit, ...) |
38
+
|`outputTimeUnit`| Sets the unit for the results display. | Time unit, see below|@OutputTimeUnit(value: BenchmarkTimeUnit) |
39
+
|`mode`| Selects "thrpt" (Throughput) for measuring the number of function calls per unit time or "avgt" (AverageTime) for measuring the time per function call. |`thrpt`, `Throughput`, `avgt`, `AverageTime`|@BenchmarkMode(value: Mode)|
40
+
|`include("…")`| Applies a regular expression to include benchmarks that match the substring in their fully qualified names. | Regex pattern| - |
41
+
|`exclude("…")`| Applies a regular expression to exclude benchmarks that match the substring in their fully qualified names. | Regex pattern| - |
42
+
|`param("name", "value1", "value2")`| Assigns values to a public mutable property with the specified name, annotated with `@Param`. | String values that represent valid values for the property|@Param|
43
+
|`reportFormat`| Defines the benchmark report's format options. |`json`(default), `csv`, `scsv`, `text`| - |
45
44
46
45
The following values can be used for specifying time unit:
0 commit comments