SVR
Support Vector Regressor using kernel-based function estimation.
SVR seeks a function that deviates from the targets by at most epsilon
(the insensitive tube) while maintaining flatness (controlled by C).
Kernel functions allow SVR to capture nonlinear relationships. The RBF kernel
is effective in many practical scenarios.
Key hyperparameters include kernel, C, epsilon, gamma, and
max_iter. The implementation wraps scikit-learn's SVR.
References
- [1] Vapnik, V.N. (1995). The Nature of Statistical Learning Theory. Springer.
- [2] https://scikit-learn.org/stable/modules/generated/sklearn.svm.SVR.html
Parameters
- kernel : string, default=
rbf - Specifies the kernel type to be used in the algorithm. 'rbf' is the default radial basis function.
- C : number, default=
1.0 - Regularisation parameter. Inversely proportional to the strength of the regularisation.
- epsilon : number, default=
0.1 - Specifies the epsilon-tube within which no penalty is associated in the training loss function.
- gamma : string, default=
scale - Kernel coefficient for 'rbf', 'poly' and 'sigmoid'. 'scale' uses 1/(n_features * X.var()); 'auto' uses 1/n_features.
- max_iter : integer, default=
-1 - Hard limit on iterations within solver. -1 means no limit.
Methods
calculate_metrics(self, split: DashAI.back.core.enums.metrics.SplitEnum = <SplitEnum.VALIDATION: 'validation'>, level: DashAI.back.core.enums.metrics.LevelEnum = <LevelEnum.LAST: 'last'>, log_index: int = None, x_data: 'DashAIDataset' = None, y_data: 'DashAIDataset' = None)
BaseModelCalculate and save metrics for a given data split and level.
Parameters
- split : SplitEnum
- The data split to evaluate (TRAIN, VALIDATION, or TEST). Defaults to SplitEnum.VALIDATION.
- level : LevelEnum
- The metric granularity level (LAST, TRIAL, STEP, or BATCH). Defaults to LevelEnum.LAST.
- log_index : int, optional
- Explicit step index for the metric entry. If None, the next step index is computed automatically. Defaults to None.
- x_data : DashAIDataset, optional
- Input features. If None, the dataset stored in the model for the given split is used. Defaults to None.
- y_data : DashAIDataset, optional
- Target labels. If None, the labels stored in the model for the given split are used. Defaults to None.
get_metadata(cls) -> Dict[str, Any]
BaseModelGet metadata values for the current model.
Returns
- Dict[str, Any]
- Dictionary containing UI metadata such as the model icon used in the DashAI frontend.
get_schema(cls) -> dict
ConfigObjectGenerates the component related Json Schema.
Returns
- dict
- Dictionary representing the Json Schema of the component.
load(filename: str) -> None
SklearnLikeModelDeserialise a model from disk using joblib.
Parameters
- filename : str
- Path to the file previously written by :meth:
save.
Returns
- SklearnLikeModel
- The loaded model instance.
predict(self, x_pred: 'DashAIDataset') -> 'ndarray'
SklearnLikeRegressorMake a prediction with the model.
Parameters
- x_pred : DashAIDataset
- Dataset with the input data columns.
Returns
- np.ndarray
- Array with the predicted target values for x_pred
prepare_dataset(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'
CategoricalEncoderMixinEncode categorical feature columns into a numeric representation.
Parameters
- dataset : DashAIDataset
- The input dataset to preprocess.
- is_fit : bool
- If True, fit the encoders on the data. If False, apply previously fitted encoders. Defaults to False.
Returns
- DashAIDataset
- The dataset with categorical columns converted to numeric columns.
prepare_output(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'
CategoricalEncoderMixinPrepare output targets using label encoding.
Parameters
- dataset : DashAIDataset
- The output dataset to be transformed.
- is_fit : bool, optional
- If True, fit the encoder. If False, use existing encodings.
Returns
- DashAIDataset
- Dataset with categorical columns converted to integers.
save(self, filename: str) -> None
SklearnLikeModelSerialise the model to disk using joblib.
Parameters
- filename : str
- Destination file path where the model will be written.
train(self, x_train, y_train, x_validation=None, y_validation=None)
SklearnLikeModelTrain the sklearn model on the provided dataset.
Parameters
- x_train : DashAIDataset
- The input features for training.
- y_train : DashAIDataset
- The target labels for training.
- x_validation : DashAIDataset, optional
- Validation input features (unused in sklearn models). Defaults to None.
- y_validation : DashAIDataset, optional
- Validation target labels (unused in sklearn models). Defaults to None.
Returns
- BaseModel
- The fitted scikit-learn estimator (self).
validate_and_transform(self, raw_data: dict) -> dict
ConfigObjectIt takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.
Parameters
- raw_data : dict
- A dictionary with the data provided by the user to initialize the model.
Returns
- dict
- A validated dictionary with the necessary objects.