Constructor
new GeneralizedLinearRegressionModel()
Extends
Methods
coefficients() → {module:eclairjs/ml/linalg.Vector}
Returns:
copy(extra) → {module:eclairjs/ml/regression.GeneralizedLinearRegressionModel}
Parameters:
| Name | Type | Description |
|---|---|---|
extra |
module:eclairjs/ml/param.ParamMap |
- Overrides:
- Source:
Returns:
evaluate(dataset) → {module:eclairjs/ml/regression.GeneralizedLinearRegressionSummary}
Evaluate the model on the given dataset, returning a summary of the results.
Parameters:
| Name | Type | Description |
|---|---|---|
dataset |
module:eclairjs/sql.Dataset |
Returns:
featuresCol() → {module:eclairjs/ml/param.Param}
Param for features column name.
- Inherited From:
- Source:
Returns:
getFeaturesCol() → {string}
- Inherited From:
- Source:
Returns:
- Type
- string
getLabelCol() → {string}
- Inherited From:
- Source:
Returns:
- Type
- string
getPredictionCol() → {string}
- Inherited From:
- Source:
Returns:
- Type
- string
hasParent() → {boolean}
- Inherited From:
- Source:
Returns:
- Type
- boolean
hasSummary() → {boolean}
Indicates if summary is available.
Returns:
- Type
- boolean
intercept() → {double}
Returns:
- Type
- double
labelCol() → {module:eclairjs/ml/param.Param}
Param for label column name.
- Inherited From:
- Source:
Returns:
load(path) → {module:eclairjs/ml/regression.GeneralizedLinearRegressionModel}
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string |
Returns:
numFeatures() → {integer}
- Inherited From:
- Source:
Returns:
- Type
- integer
parent() → {module:eclairjs/ml.Estimator}
- Inherited From:
- Source:
Returns:
predictionCol() → {module:eclairjs/ml/param.Param}
Param for prediction column name.
- Inherited From:
- Source:
Returns:
read() → {module:eclairjs/ml/util.MLReader}
Returns:
setFeaturesCol(value) → {object}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
- Inherited From:
- Source:
Returns:
- Type
- object
setLinkPredictionCol(value) → {module:eclairjs/ml/regression.GeneralizedLinearRegressionModel}
Sets the link prediction (linear predictor) column name.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
setParent(parent) → {object}
Sets the parent of this model.
Parameters:
| Name | Type | Description |
|---|---|---|
parent |
module:eclairjs/ml.Estimator |
- Inherited From:
- Source:
Returns:
- Type
- object
setPredictionCol(value) → {object}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
- Inherited From:
- Source:
Returns:
- Type
- object
summary() → {module:eclairjs/ml/regression.GeneralizedLinearRegressionTrainingSummary}
Gets R-like summary of model on training set. An exception is
thrown if there is no summary available.
Returns:
transform(dataset) → {DataFrame}
Parameters:
| Name | Type | Description |
|---|---|---|
dataset |
module:eclairjs/sql.Dataset |
- Overrides:
- Source:
Returns:
- Type
- DataFrame
transformSchema(schema) → {module:eclairjs/sql/types.StructType}
Parameters:
| Name | Type | Description |
|---|---|---|
schema |
module:eclairjs/sql/types.StructType |
- Inherited From:
- Source:
Returns:
validateAndTransformSchema(schema, fitting, featuresDataType) → {module:eclairjs/sql/types.StructType}
Validates and transforms the input schema with the provided param map.
Parameters:
| Name | Type | Description |
|---|---|---|
schema |
module:eclairjs/sql/types.StructType | |
fitting |
boolean | whether this is in fitting |
featuresDataType |
module:eclairjs/sql/types.DataType | SQL DataType for FeaturesType. E.g., module:eclairjs/sql/types.VectorUDTfor vector features |
- Inherited From:
- Source:
Returns:
write() → {module:eclairjs/ml/util.MLWriter}
Returns a MLWriter instance for this ML instance.
For GeneralizedLinearRegressionModel, this does NOT currently save the
training [[summary]]. An option to save summary may be added in the future.