Skip to content

Add-BenchmarkComparison.md

Latest commit

 

History

History
123 lines (95 loc) · 2.46 KB

Add-BenchmarkComparison.md

File metadata and controls

123 lines (95 loc) · 2.46 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

Add-BenchmarkComparison

SYNOPSIS

Adds a benchmark comparison definition.

SYNTAX

__AllParameterSets

Add-BenchmarkComparison [[-Dimension] <string>] -Baseline <string> [-Metric <string[]>] [-TieTolerance <double>] [-RequireBaselineFastest] [<CommonParameters>]

DESCRIPTION

Adds a benchmark comparison definition.

EXAMPLES

EXAMPLE 1

Add-BenchmarkComparison -Baseline 'Value'

PARAMETERS

-Baseline

Baseline value.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Dimension

Dimension to compare.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Metric

Metric names.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RequireBaselineFastest

Fail the benchmark when the baseline is materially slower than a successful competitor.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TieTolerance

Fractional tolerance used to label practically equivalent results, such as 0.05 for five percent.

Type: Double
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • System.Object

RELATED LINKS

  • None