Command

Add-BenchmarkComparison

Module: PSPublishModule
Inputs: None

Adds a benchmark comparison definition.

Syntax

Add-BenchmarkComparison
-Baseline <String>
[[-Dimension] <String>]
[-Metric <String[]>]
[-RequireBaselineFastest]
[-TieTolerance <Double>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Example 1

Add-BenchmarkComparison -Baseline 'Value'

Parameters

-Baseline String required: Baseline value.
-Dimension String optionalposition: 0: Dimension to compare.
-Metric String[] optional: Metric names.
-RequireBaselineFastest SwitchParameter optional: Fail the benchmark when the baseline is materially slower than a successful competitor.
-TieTolerance Double optional: Fractional tolerance used to label practically equivalent results, such as 0.05 for five percent.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.