snowflake.ml.modeling.linear_model.PassiveAggressiveRegressor¶

class snowflake.ml.modeling.linear_model.PassiveAggressiveRegressor(*, C=1.0, fit_intercept=True, max_iter=1000, tol=0.001, early_stopping=False, validation_fraction=0.1, n_iter_no_change=5, shuffle=True, verbose=0, loss='epsilon_insensitive', epsilon=0.1, random_state=None, warm_start=False, average=False, input_cols: Optional[Union[str, Iterable[str]]] = None, output_cols: Optional[Union[str, Iterable[str]]] = None, label_cols: Optional[Union[str, Iterable[str]]] = None, passthrough_cols: Optional[Union[str, Iterable[str]]] = None, drop_input_cols: Optional[bool] = False, sample_weight_col: Optional[str] = None)¶

Bases: BaseTransformer

Passive Aggressive Regressor For more details on this class, see sklearn.linear_model.PassiveAggressiveRegressor

input_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that contain features. If this parameter is not specified, all columns in the input DataFrame except the columns specified by label_cols, sample_weight_col, and passthrough_cols parameters are considered input columns. Input columns can also be set after initialization with the set_input_cols method.

label_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that contain labels. Label columns must be specified with this parameter during initialization or with the set_label_cols method before fitting.

output_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that will store the output of predict and transform operations. The length of output_cols must match the expected number of output columns from the specific predictor or transformer class used. If you omit this parameter, output column names are derived by adding an OUTPUT_ prefix to the label column names for supervised estimators, or OUTPUT_<IDX>for unsupervised estimators. These inferred output column names work for predictors, but output_cols must be set explicitly for transformers. In general, explicitly specifying output column names is clearer, especially if you don’t specify the input column names. To transform in place, pass the same names for input_cols and output_cols. be set explicitly for transformers. Output columns can also be set after initialization with the set_output_cols method.

sample_weight_col: Optional[str]

A string representing the column name containing the sample weights. This argument is only required when working with weighted datasets. Sample weight column can also be set after initialization with the set_sample_weight_col method.

passthrough_cols: Optional[Union[str, List[str]]]

A string or a list of strings indicating column names to be excluded from any operations (such as train, transform, or inference). These specified column(s) will remain untouched throughout the process. This option is helpful in scenarios requiring automatic input_cols inference, but need to avoid using specific columns, like index columns, during training or inference. Passthrough columns can also be set after initialization with the set_passthrough_cols method.

drop_input_cols: Optional[bool], default=False

If set, the response of predict(), transform() methods will not contain input columns.

C: float, default=1.0

Maximum step size (regularization). Defaults to 1.0.

fit_intercept: bool, default=True

Whether the intercept should be estimated or not. If False, the data is assumed to be already centered. Defaults to True.

max_iter: int, default=1000

The maximum number of passes over the training data (aka epochs). It only impacts the behavior in the fit method, and not the partial_fit() method.

tol: float or None, default=1e-3

The stopping criterion. If it is not None, the iterations will stop when (loss > previous_loss - tol).

early_stopping: bool, default=False

Whether to use early stopping to terminate training when validation. score is not improving. If set to True, it will automatically set aside a fraction of training data as validation and terminate training when validation score is not improving by at least tol for n_iter_no_change consecutive epochs.

validation_fraction: float, default=0.1

The proportion of training data to set aside as validation set for early stopping. Must be between 0 and 1. Only used if early_stopping is True.

n_iter_no_change: int, default=5

Number of iterations with no improvement to wait before early stopping.

shuffle: bool, default=True

Whether or not the training data should be shuffled after each epoch.

verbose: int, default=0

The verbosity level.

loss: str, default=”epsilon_insensitive”

The loss function to be used: epsilon_insensitive: equivalent to PA-I in the reference paper. squared_epsilon_insensitive: equivalent to PA-II in the reference paper.

epsilon: float, default=0.1

If the difference between the current prediction and the correct label is below this threshold, the model is not updated.

random_state: int, RandomState instance, default=None

Used to shuffle the training data, when shuffle is set to True. Pass an int for reproducible output across multiple function calls. See Glossary.

warm_start: bool, default=False

When set to True, reuse the solution of the previous call to fit as initialization, otherwise, just erase the previous solution. See the Glossary.

Repeatedly calling fit or partial_fit when warm_start is True can result in a different solution than when calling fit a single time because of the way the data is shuffled.

average: bool or int, default=False

When set to True, computes the averaged SGD weights and stores the result in the coef_ attribute. If set to an int greater than 1, averaging will begin once the total number of samples seen reaches average. So average=10 will begin averaging after seeing 10 samples.

Methods

fit(dataset)	Fit linear model with Passive Aggressive algorithm For more details on this function, see sklearn.linear_model.PassiveAggressiveRegressor.fit
get_input_cols()	Input columns getter.
get_label_cols()	Label column getter.
get_output_cols()	Output columns getter.
get_params([deep])	Get parameters for this transformer.
get_passthrough_cols()	Passthrough columns getter.
get_sample_weight_col()	Sample weight column getter.
get_sklearn_args([default_sklearn_obj, ...])	Get sklearn keyword arguments.
predict(dataset)	Predict using the linear model For more details on this function, see sklearn.linear_model.PassiveAggressiveRegressor.predict
score(dataset)	Return the coefficient of determination of the prediction For more details on this function, see sklearn.linear_model.PassiveAggressiveRegressor.score
set_drop_input_cols([drop_input_cols])
set_input_cols(input_cols)	Input columns setter.
set_label_cols(label_cols)	Label column setter.
set_output_cols(output_cols)	Output columns setter.
set_params(**params)	Set the parameters of this transformer.
set_passthrough_cols(passthrough_cols)	Passthrough columns setter.
set_sample_weight_col(sample_weight_col)	Sample weight column setter.
to_sklearn()	Get sklearn.linear_model.PassiveAggressiveRegressor object.

Attributes

model_signatures

Returns model signature of current class.