AutoCatalog.CreateRankingExperiment Method

Definition

Namespace:

Microsoft.ML.AutoML

Assembly:

Microsoft.ML.AutoML.dll

Package:

Microsoft.ML.AutoML v0.20.0-preview.22313.1

Overloads

CreateRankingExperiment(RankingExperimentSettings)	Creates a new AutoML experiment to run on a ranking dataset.
CreateRankingExperiment(UInt32)	Creates a new AutoML experiment to run on a ranking dataset.

CreateRankingExperiment(RankingExperimentSettings)

Creates a new AutoML experiment to run on a ranking dataset.

public Microsoft.ML.AutoML.RankingExperiment CreateRankingExperiment (Microsoft.ML.AutoML.RankingExperimentSettings experimentSettings);

member this.CreateRankingExperiment : Microsoft.ML.AutoML.RankingExperimentSettings -> Microsoft.ML.AutoML.RankingExperiment

Public Function CreateRankingExperiment (experimentSettings As RankingExperimentSettings) As RankingExperiment

Parameters

experimentSettings

RankingExperimentSettings

Settings for the AutoML experiment.

Returns

RankingExperiment

A new AutoML ranking experiment.

Remarks

See RankingExperiment for a more detailed code example of an AutoML ranking experiment.

CreateRankingExperiment(UInt32)

Creates a new AutoML experiment to run on a ranking dataset.

public Microsoft.ML.AutoML.RankingExperiment CreateRankingExperiment (uint maxExperimentTimeInSeconds);

member this.CreateRankingExperiment : uint32 -> Microsoft.ML.AutoML.RankingExperiment

Public Function CreateRankingExperiment (maxExperimentTimeInSeconds As UInteger) As RankingExperiment

Parameters

maxExperimentTimeInSeconds

UInt32

Maximum number of seconds that experiment will run.

Returns

RankingExperiment

A new AutoML ranking experiment.

Remarks

See RankingExperiment for a more detailed code example of an AutoML ranking experiment.

An experiment may run for longer than maxExperimentTimeInSeconds. This is because once AutoML starts training an ML.NET model, AutoML lets the model train to completion. For instance, if the first model AutoML trains takes 4 hours, and the second model trained takes 5 hours, but maxExperimentTimeInSeconds was the number of seconds in 6 hours, the experiment will run for 4 + 5 = 9 hours (not 6 hours).