Class HyperparameterTuningContext

The Hyperparameter Tuning Context that makes up part of the ppo configuration. This object maps to a

HyperparameterTuningConfig

Attributes:

strategy (str): The hyperparameter tuning strategy.

iteration_scale (int): The iteration scale [1-10]. The smaller the number, the less iterations that are run. The iteration

scale acts is an abstraction on top of model specific iterations. Must be set if iterations is None.

iterations (int, optional): The exact amount of iterations to run for that particular model. Must be set if iteration_scale is None.

early_stopping_proportion (float): The proportion of iterations [0 -1]to run without an improvement in the metric score before ending

hypertuning early.

n_hypertune_workers (int): THe number of hypertune workers that are allowed to be run at the same time for a particular

model during training. Use -1 to use the max number of allowed workers by the engine. If the provided number

is greater than th max number of allowed workers than it will set it to the max number of allowed workers.

See Also:

PPOContext

HyperparameterTuningConfig

Namespace: Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting

Assembly: Xperiflow.dll

Declaration

public class HyperparameterTuningContext

Properties

Strategy

Declaration

[JsonProperty("strategy", Required = Required.Always)]
public string Strategy { get; set; }

IterationScale

Declaration

[JsonProperty("iteration_scale", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? IterationScale { get; set; }

Iterations

Declaration

[JsonProperty("iterations", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? Iterations { get; set; }

EarlyStoppingProportion

Declaration

[JsonProperty("early_stopping_proportion", Required = Required.Always)]
public double EarlyStoppingProportion { get; set; }

NHypertuneWorkers

Declaration

[JsonProperty("n_hypertune_workers", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public int? NHypertuneWorkers { get; set; }

AdditionalProperties

Declaration

[JsonExtensionData]
public IDictionary<string, object> AdditionalProperties { get; set; }

Methods

ToJson()

Declaration

public string ToJson()

Returns

System.String

FromJson(string)

Declaration

public static HyperparameterTuningContext FromJson(string data)

Returns

Workspace.XBR.Xperiflow.Core.RestApi.TimeSeriesForecasting.HyperparameterTuningContext

Parameters

Type	Name
System.String	data

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString