TuneHyperparametersModel implements TuneHyperparametersModel More...
Inheritance diagram for Synapse.ML.Automl.TuneHyperparametersModel:
Collaboration diagram for Synapse.ML.Automl.TuneHyperparametersModel:
Public Member Functions | |
| TuneHyperparametersModel () | |
| Creates a TuneHyperparametersModel without any parameters. More... | |
| TuneHyperparametersModel (string uid) | |
| Creates a TuneHyperparametersModel with a UID that is used to give the TuneHyperparametersModel a unique ID. More... | |
| TuneHyperparametersModel | SetBestMetric (double value) |
| Sets value for bestMetric More... | |
| TuneHyperparametersModel | SetBestModel (JavaTransformer value) |
| Sets value for bestModel More... | |
| double | GetBestMetric () |
| Gets bestMetric value More... | |
| JavaTransformer | GetBestModel () |
| Gets bestModel value More... | |
| void | Save (string path) |
| Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More... | |
| JavaMLWriter | Write () |
| |
| JavaMLReader< TuneHyperparametersModel > | Read () |
| Get the corresponding JavaMLReader instance. More... | |
Static Public Member Functions | |
| static TuneHyperparametersModel | Load (string path) |
| Loads the TuneHyperparametersModel that was previously saved using Save(string). More... | |
Detailed Description
TuneHyperparametersModel implements TuneHyperparametersModel
Constructor & Destructor Documentation
◆ TuneHyperparametersModel() [1/2]
|
inline |
Creates a TuneHyperparametersModel without any parameters.
◆ TuneHyperparametersModel() [2/2]
|
inline |
Creates a TuneHyperparametersModel with a UID that is used to give the TuneHyperparametersModel a unique ID.
- Parameters
-
uid An immutable unique ID for the object and its derivatives.
Member Function Documentation
◆ GetBestMetric()
| double Synapse.ML.Automl.TuneHyperparametersModel.GetBestMetric | ( | ) |
Gets bestMetric value
- Returns
- bestMetric: the best metric from the runs
◆ GetBestModel()
|
inline |
Gets bestModel value
- Returns
- bestModel: the best model found
◆ Load()
|
static |
Loads the TuneHyperparametersModel that was previously saved using Save(string).
- Parameters
-
path The path the previous TuneHyperparametersModel was saved to
- Returns
- New TuneHyperparametersModel object, loaded from path.
◆ Read()
| JavaMLReader<TuneHyperparametersModel> Synapse.ML.Automl.TuneHyperparametersModel.Read | ( | ) |
Get the corresponding JavaMLReader instance.
- Returns
- an JavaMLReader<TuneHyperparametersModel> instance for this ML instance.
◆ Save()
| void Synapse.ML.Automl.TuneHyperparametersModel.Save | ( | string | path | ) |
Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.
- Parameters
-
path The path to save the object to
◆ SetBestMetric()
| TuneHyperparametersModel Synapse.ML.Automl.TuneHyperparametersModel.SetBestMetric | ( | double | value | ) |
Sets value for bestMetric
- Parameters
-
value the best metric from the runs
- Returns
- New TuneHyperparametersModel object
◆ SetBestModel()
| TuneHyperparametersModel Synapse.ML.Automl.TuneHyperparametersModel.SetBestModel | ( | JavaTransformer | value | ) |
Sets value for bestModel
- Parameters
-
value the best model found
- Returns
- New TuneHyperparametersModel object
The documentation for this class was generated from the following file:
- synapse/ml/automl/TuneHyperparametersModel.cs
