Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Lightgbm.LightGBMRankerModel Class Reference

LightGBMRankerModel implements LightGBMRankerModel More...

Inheritance diagram for Synapse.ML.Lightgbm.LightGBMRankerModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Lightgbm.LightGBMRankerModel:
Collaboration graph
[legend]

Public Member Functions

 LightGBMRankerModel ()
 Creates a LightGBMRankerModel without any parameters. More...
 
 LightGBMRankerModel (string uid)
 Creates a LightGBMRankerModel with a UID that is used to give the LightGBMRankerModel a unique ID. More...
 
LightGBMRankerModel SetFeaturesCol (string value)
 Sets value for featuresCol More...
 
LightGBMRankerModel SetFeaturesShapCol (string value)
 Sets value for featuresShapCol More...
 
LightGBMRankerModel SetLabelCol (string value)
 Sets value for labelCol More...
 
LightGBMRankerModel SetLeafPredictionCol (string value)
 Sets value for leafPredictionCol More...
 
LightGBMRankerModel SetLightGBMBooster (LightGBMBooster value)
 Sets value for lightGBMBooster More...
 
LightGBMRankerModel SetNumIterations (int value)
 Sets value for numIterations More...
 
LightGBMRankerModel SetPredictDisableShapeCheck (bool value)
 Sets value for predictDisableShapeCheck More...
 
LightGBMRankerModel SetPredictionCol (string value)
 Sets value for predictionCol More...
 
LightGBMRankerModel SetStartIteration (int value)
 Sets value for startIteration More...
 
string GetFeaturesCol ()
 Gets featuresCol value More...
 
string GetFeaturesShapCol ()
 Gets featuresShapCol value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
string GetLeafPredictionCol ()
 Gets leafPredictionCol value More...
 
LightGBMBooster GetLightGBMBooster ()
 Gets lightGBMBooster value More...
 
int GetNumIterations ()
 Gets numIterations value More...
 
bool GetPredictDisableShapeCheck ()
 Gets predictDisableShapeCheck value More...
 
string GetPredictionCol ()
 Gets predictionCol value More...
 
int GetStartIteration ()
 Gets startIteration 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 ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< LightGBMRankerModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static LightGBMRankerModel Load (string path)
 Loads the LightGBMRankerModel that was previously saved using Save(string). More...
 

Detailed Description

LightGBMRankerModel implements LightGBMRankerModel

Constructor & Destructor Documentation

◆ LightGBMRankerModel() [1/2]

Synapse.ML.Lightgbm.LightGBMRankerModel.LightGBMRankerModel ( )
inline

Creates a LightGBMRankerModel without any parameters.

◆ LightGBMRankerModel() [2/2]

Synapse.ML.Lightgbm.LightGBMRankerModel.LightGBMRankerModel ( string  uid)
inline

Creates a LightGBMRankerModel with a UID that is used to give the LightGBMRankerModel a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetFeaturesCol()

string Synapse.ML.Lightgbm.LightGBMRankerModel.GetFeaturesCol ( )

Gets featuresCol value

Returns
featuresCol: features column name

◆ GetFeaturesShapCol()

string Synapse.ML.Lightgbm.LightGBMRankerModel.GetFeaturesShapCol ( )

Gets featuresShapCol value

Returns
featuresShapCol: Output SHAP vector column name after prediction containing the feature contribution values

◆ GetLabelCol()

string Synapse.ML.Lightgbm.LightGBMRankerModel.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: label column name

◆ GetLeafPredictionCol()

string Synapse.ML.Lightgbm.LightGBMRankerModel.GetLeafPredictionCol ( )

Gets leafPredictionCol value

Returns
leafPredictionCol: Predicted leaf indices's column name

◆ GetLightGBMBooster()

LightGBMBooster Synapse.ML.Lightgbm.LightGBMRankerModel.GetLightGBMBooster ( )

Gets lightGBMBooster value

Returns
lightGBMBooster: The trained LightGBM booster

◆ GetNumIterations()

int Synapse.ML.Lightgbm.LightGBMRankerModel.GetNumIterations ( )

Gets numIterations value

Returns
numIterations: Sets the total number of iterations used in the prediction.If <= 0, all iterations from start_iteration are used (no limits).

◆ GetPredictDisableShapeCheck()

bool Synapse.ML.Lightgbm.LightGBMRankerModel.GetPredictDisableShapeCheck ( )

Gets predictDisableShapeCheck value

Returns
predictDisableShapeCheck: control whether or not LightGBM raises an error when you try to predict on data with a different number of features than the training data

◆ GetPredictionCol()

string Synapse.ML.Lightgbm.LightGBMRankerModel.GetPredictionCol ( )

Gets predictionCol value

Returns
predictionCol: prediction column name

◆ GetStartIteration()

int Synapse.ML.Lightgbm.LightGBMRankerModel.GetStartIteration ( )

Gets startIteration value

Returns
startIteration: Sets the start index of the iteration to predict. If <= 0, starts from the first iteration.

◆ Load()

static LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.Load ( string  path)
static

Loads the LightGBMRankerModel that was previously saved using Save(string).

Parameters
pathThe path the previous LightGBMRankerModel was saved to
Returns
New LightGBMRankerModel object, loaded from path.

◆ Read()

JavaMLReader<LightGBMRankerModel> Synapse.ML.Lightgbm.LightGBMRankerModel.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<LightGBMRankerModel> instance for this ML instance.

◆ Save()

void Synapse.ML.Lightgbm.LightGBMRankerModel.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
pathThe path to save the object to

◆ SetFeaturesCol()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetFeaturesCol ( string  value)

Sets value for featuresCol

Parameters
valuefeatures column name
Returns
New LightGBMRankerModel object

◆ SetFeaturesShapCol()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetFeaturesShapCol ( string  value)

Sets value for featuresShapCol

Parameters
valueOutput SHAP vector column name after prediction containing the feature contribution values
Returns
New LightGBMRankerModel object

◆ SetLabelCol()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valuelabel column name
Returns
New LightGBMRankerModel object

◆ SetLeafPredictionCol()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetLeafPredictionCol ( string  value)

Sets value for leafPredictionCol

Parameters
valuePredicted leaf indices's column name
Returns
New LightGBMRankerModel object

◆ SetLightGBMBooster()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetLightGBMBooster ( LightGBMBooster  value)

Sets value for lightGBMBooster

Parameters
valueThe trained LightGBM booster
Returns
New LightGBMRankerModel object

◆ SetNumIterations()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetNumIterations ( int  value)

Sets value for numIterations

Parameters
valueSets the total number of iterations used in the prediction.If <= 0, all iterations from start_iteration are used (no limits).
Returns
New LightGBMRankerModel object

◆ SetPredictDisableShapeCheck()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetPredictDisableShapeCheck ( bool  value)

Sets value for predictDisableShapeCheck

Parameters
valuecontrol whether or not LightGBM raises an error when you try to predict on data with a different number of features than the training data
Returns
New LightGBMRankerModel object

◆ SetPredictionCol()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetPredictionCol ( string  value)

Sets value for predictionCol

Parameters
valueprediction column name
Returns
New LightGBMRankerModel object

◆ SetStartIteration()

LightGBMRankerModel Synapse.ML.Lightgbm.LightGBMRankerModel.SetStartIteration ( int  value)

Sets value for startIteration

Parameters
valueSets the start index of the iteration to predict. If <= 0, starts from the first iteration.
Returns
New LightGBMRankerModel object

The documentation for this class was generated from the following file: