Class BanditPolicy
- java.lang.Object
-
- com.azure.resourcemanager.machinelearning.models.EarlyTerminationPolicy
-
- com.azure.resourcemanager.machinelearning.models.BanditPolicy
-
public final class BanditPolicy extends EarlyTerminationPolicy
Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation.
-
-
Constructor Summary
Constructors Constructor Description BanditPolicy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Float
slackAmount()
Get the slackAmount property: Absolute distance allowed from the best performing run.Float
slackFactor()
Get the slackFactor property: Ratio of the allowed distance from the best performing run.void
validate()
Validates the instance.BanditPolicy
withDelayEvaluation(Integer delayEvaluation)
Set the delayEvaluation property: Number of intervals by which to delay the first evaluation.BanditPolicy
withEvaluationInterval(Integer evaluationInterval)
Set the evaluationInterval property: Interval (number of runs) between policy evaluations.BanditPolicy
withSlackAmount(Float slackAmount)
Set the slackAmount property: Absolute distance allowed from the best performing run.BanditPolicy
withSlackFactor(Float slackFactor)
Set the slackFactor property: Ratio of the allowed distance from the best performing run.-
Methods inherited from class com.azure.resourcemanager.machinelearning.models.EarlyTerminationPolicy
delayEvaluation, evaluationInterval
-
-
-
-
Method Detail
-
slackAmount
public Float slackAmount()
Get the slackAmount property: Absolute distance allowed from the best performing run.- Returns:
- the slackAmount value.
-
withSlackAmount
public BanditPolicy withSlackAmount(Float slackAmount)
Set the slackAmount property: Absolute distance allowed from the best performing run.- Parameters:
slackAmount
- the slackAmount value to set.- Returns:
- the BanditPolicy object itself.
-
slackFactor
public Float slackFactor()
Get the slackFactor property: Ratio of the allowed distance from the best performing run.- Returns:
- the slackFactor value.
-
withSlackFactor
public BanditPolicy withSlackFactor(Float slackFactor)
Set the slackFactor property: Ratio of the allowed distance from the best performing run.- Parameters:
slackFactor
- the slackFactor value to set.- Returns:
- the BanditPolicy object itself.
-
withDelayEvaluation
public BanditPolicy withDelayEvaluation(Integer delayEvaluation)
Set the delayEvaluation property: Number of intervals by which to delay the first evaluation.- Overrides:
withDelayEvaluation
in classEarlyTerminationPolicy
- Parameters:
delayEvaluation
- the delayEvaluation value to set.- Returns:
- the EarlyTerminationPolicy object itself.
-
withEvaluationInterval
public BanditPolicy withEvaluationInterval(Integer evaluationInterval)
Set the evaluationInterval property: Interval (number of runs) between policy evaluations.- Overrides:
withEvaluationInterval
in classEarlyTerminationPolicy
- Parameters:
evaluationInterval
- the evaluationInterval value to set.- Returns:
- the EarlyTerminationPolicy object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classEarlyTerminationPolicy
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-