Class: GeneralizedLinearRegressionModel

eclairjs/ml/regression.GeneralizedLinearRegressionModel

:: Experimental :: Model produced by module:eclairjs/ml/regression.GeneralizedLinearRegression.

Constructor

new GeneralizedLinearRegressionModel()

Source:

Extends

  • module:eclairjs/mllib/regression.RegressionModel

Methods

(static) load(path) → {module:eclairjs/mllib/regression.GeneralizedLinearRegressionModel}

Parameters:
Name Type Description
path string
Source:
Returns:
Type
module:eclairjs/mllib/regression.GeneralizedLinearRegressionModel

(static) read() → {MLReader}

Source:
Returns:
Type
MLReader

coefficients() → {module:eclairjs/ml/linalg.Vector}

Source:
Returns:
Type
module:eclairjs/ml/linalg.Vector

copy(extra) → {module:eclairjs/mllib/regression.GeneralizedLinearRegressionModel}

Parameters:
Name Type Description
extra module:eclairjs/ml/param.ParamMap
Source:
Returns:
Type
module:eclairjs/mllib/regression.GeneralizedLinearRegressionModel

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
Source:
Returns:
Type
module:eclairjs/ml/regression.GeneralizedLinearRegressionSummary

hasSummary() → {Promise.<boolean>}

Indicates if module:eclairjs/ml/regression.GeneralizedLinearRegressionTrainingSummary is available.
Source:
Returns:
Type
Promise.<boolean>

intercept() → {Promise.<number>}

Source:
Returns:
Type
Promise.<number>

setLinkPredictionCol(value) → {module:eclairjs/ml/regression.GeneralizedLinearRegressionModel}

Sets the link prediction (linear predictor) column name.
Parameters:
Name Type Description
value string
Source:
Returns:
* @returns
Type
module:eclairjs/ml/regression.GeneralizedLinearRegressionModel

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.
Source:
Returns:
Type
module:eclairjs/ml/regression.GeneralizedLinearRegressionTrainingSummary

transform(dataset) → {module:eclairjs/sql.Dataset}

Parameters:
Name Type Description
dataset module:eclairjs/sql.Dataset
Source:
Returns:
Type
module:eclairjs/sql.Dataset

uid() → {Promise.<string>}

An immutable unique ID for the object and its derivatives.
Source:
Returns:
Type
Promise.<string>

write() → {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. This also does not save the parent currently.
Source:
Returns:
Type
MLWriter