vastorbit.machine_learning.vast.linear_model.ElasticNet¶

class vastorbit.machine_learning.vast.linear_model.ElasticNet(name: str = None, overwrite_model: bool = False, **kwargs)¶

Creates an ElasticNet object using scikit-learn for training and the scalability of VAST DataBase for the inferences.

Parameters:

name (str, optional) – Name of the model. The model is stored in the database.
overwrite_model (bool, optional) – If set to True, training a model with the same name as an existing model overwrites the existing model.
**kwargs (scikit-learn model parameters.)

Variables:

created (Many attributes are)
phase. (during the fitting)
coef_ (numpy.array) – The regression coefficients. The order of coefficients is the same as the order of columns used during the fitting phase.
intercept_ (float) – The expected value of the dependent variable when all independent variables are zero, serving as the baseline or constant term in the model.
feature_importances_ (numpy.array) – The importance of features is computed through the model coefficients, which are normalized based on their range. Subsequently, an activation function calculates the final score. It is necessary to use the features_importance() method to compute it initially, and the computed values will be subsequently utilized for subsequent calls.
note:: (..) – All attributes can be accessed using the get_attributes() method.

Examples

The following examples provide a basic understanding of usage. For more detailed examples, please refer to the Machine Learning or the Examples section on the website.

Load data for machine learning¶

We import vastorbit:

import vastorbit as vo

Hint

By assigning an alias to vastorbit, we mitigate the risk of code collisions with other libraries. This precaution is necessary because vastorbit uses commonly known function names like “average” and “median”, which can potentially lead to naming conflicts. The use of an alias ensures that the functions from vastorbit are used as intended without interfering with functions from other libraries.

For this example, we will use the winequality dataset.

import vastorbit.datasets as vod

data = vod.load_winequality()

	123 fixed_acidity Decimal(6, 3)	123 volatile_acidity Decimal(7, 4)	123 citric_acid Decimal(6, 3)	123 residual_sugar Decimal(7, 3)	123 chlorides Double	123 free_sulfur_dioxide Decimal(7, 2)	123 total_sulfur_dioxide Decimal(7, 2)	123 density Double	123 ph Decimal(6, 3)	123 sulphates Decimal(6, 3)	123 alcohol Double	123 quality Integer	123 good Integer	Abc color Varchar(20)
1	6.3	0.67	0.48	12.6	0.052	57.0	222.0	0.9979	3.17	0.52	9.3	6	0	white
2	7.4	0.4	0.29	5.4	0.044	31.0	122.0	0.994	3.3	0.5	11.1	8	1	white
3	7.1	0.26	0.31	2.2	0.044	29.0	128.0	0.9937	3.34	0.64	10.9	8	1	white
4	9.0	0.31	0.48	6.6	0.043	11.0	73.0	0.9938	2.9	0.38	11.6	5	0	white
5	6.3	0.39	0.24	6.9	0.069	9.0	117.0	0.9942	3.15	0.35	10.2	4	0	white
6	8.2	0.22	0.36	6.8	0.034	12.0	90.0	0.9944	3.01	0.38	10.5	8	1	white
7	7.1	0.19	0.28	3.6	0.033	16.0	78.0	0.993	2.91	0.78	11.4	6	0	white
8	7.3	0.25	0.36	13.1	0.05	35.0	200.0	0.9986	3.04	0.46	8.9	7	1	white
9	7.9	0.2	0.34	1.2	0.04	29.0	118.0	0.9932	3.14	0.41	10.6	6	0	white
10	7.1	0.26	0.32	5.9	0.037	39.0	97.0	0.9934	3.31	0.4	11.6	6	0	white
11	7.0	0.2	0.34	5.7	0.035	32.0	83.0	0.9928	3.19	0.46	11.5	6	0	white
12	6.9	0.3	0.33	4.1	0.035	26.0	155.0	0.9925	3.25	0.79	12.3	8	1	white
13	8.1	0.29	0.49	7.1	0.042	22.0	124.0	0.9944	3.14	0.41	10.8	6	0	white
14	5.8	0.17	0.3	1.4	0.037	55.0	130.0	0.9909	3.29	0.38	11.3	6	0	white
15	5.9	0.415	0.02	0.8	0.038	22.0	63.0	0.9932	3.36	0.36	9.3	5	0	white
16	6.6	0.23	0.26	1.3	0.045	16.0	128.0	0.9934	3.36	0.6	10.0	6	0	white
17	8.6	0.55	0.35	15.55	0.057	35.5	366.5	1.0001	3.04	0.63	11.0	3	0	white
18	6.9	0.35	0.74	1.0	0.044	18.0	132.0	0.992	3.13	0.55	10.2	5	0	white
19	7.6	0.14	0.74	1.6	0.04	27.0	103.0	0.9916	3.07	0.4	10.8	7	1	white
20	9.2	0.28	0.49	11.8	0.042	29.0	137.0	0.998	3.1	0.34	10.1	4	0	white
21	6.2	0.18	0.49	4.5	0.047	17.0	90.0	0.9919	3.27	0.37	11.6	6	0	white
22	5.3	0.165	0.24	1.1	0.051	25.0	105.0	0.9925	3.32	0.47	9.1	5	0	white
23	9.8	0.25	0.74	10.0	0.056	36.0	225.0	0.9977	3.06	0.43	10.0	4	0	white
24	8.1	0.29	0.49	7.1	0.042	22.0	124.0	0.9944	3.14	0.41	10.8	6	0	white
25	6.8	0.22	0.49	0.9	0.052	26.0	128.0	0.991	3.25	0.35	11.4	6	0	white
26	7.2	0.22	0.49	1.0	0.045	34.0	140.0	0.99	3.05	0.34	12.7	6	0	white
27	7.4	0.25	0.49	1.1	0.042	35.0	156.0	0.9917	3.13	0.55	11.3	5	0	white
28	8.2	0.18	0.49	1.1	0.033	28.0	81.0	0.9923	3.0	0.68	10.4	7	1	white
29	6.1	0.22	0.49	1.5	0.051	18.0	87.0	0.9928	3.3	0.46	9.6	5	0	white
30	7.0	0.39	0.24	1.0	0.048	8.0	119.0	0.9923	3.0	0.31	10.1	4	0	white
31	6.1	0.22	0.49	1.5	0.051	18.0	87.0	0.9928	3.3	0.46	9.6	5	0	white
32	6.5	0.36	0.49	2.9	0.03	16.0	94.0	0.9902	3.1	0.49	12.1	7	1	white
33	7.1	0.29	0.49	1.2	0.031	32.0	99.0	0.9893	3.07	0.33	12.2	6	0	white
34	7.4	0.25	0.49	1.1	0.042	35.0	156.0	0.9917	3.13	0.55	11.3	5	0	white
35	6.9	0.23	0.24	14.2	0.053	19.0	94.0	0.9982	3.17	0.5	9.6	5	0	white
36	8.5	0.56	0.74	17.85	0.051	51.0	243.0	1.0005	2.99	0.7	9.2	5	0	white
37	8.2	0.18	0.49	1.1	0.033	28.0	81.0	0.9923	3.0	0.68	10.4	7	1	white
38	6.3	0.23	0.49	7.1	0.05	67.0	210.0	0.9951	3.23	0.34	9.5	5	0	white
39	6.1	0.25	0.49	7.6	0.052	67.0	226.0	0.9956	3.16	0.47	8.9	5	0	white
40	7.2	0.26	0.74	13.6	0.05	56.0	162.0	0.998	3.03	0.44	8.8	5	0	white
41	7.2	0.31	0.24	1.4	0.057	17.0	117.0	0.9928	3.16	0.35	10.5	5	0	white
42	8.0	0.25	0.49	1.2	0.061	27.0	117.0	0.9938	3.08	0.34	9.4	5	0	white
43	7.0	0.18	0.49	5.3	0.04	34.0	125.0	0.9914	3.24	0.4	12.2	6	0	white
44	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white
45	8.3	0.2	0.74	4.45	0.044	33.0	130.0	0.9924	3.25	0.42	12.2	6	0	white
46	6.3	0.27	0.49	1.2	0.063	35.0	92.0	0.9911	3.38	0.42	12.2	6	0	white
47	7.4	0.16	0.49	1.2	0.055	18.0	150.0	0.9917	3.23	0.47	11.2	6	0	white
48	7.4	0.16	0.49	1.2	0.055	18.0	150.0	0.9917	3.23	0.47	11.2	6	0	white
49	6.9	0.19	0.49	6.6	0.036	49.0	172.0	0.9932	3.2	0.27	11.5	6	0	white
50	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white
51	7.2	0.4	0.49	1.1	0.048	11.0	138.0	0.9929	3.01	0.42	9.3	5	0	white
52	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white
53	7.6	0.52	0.49	14.0	0.034	37.0	156.0	0.9958	3.14	0.38	11.8	7	1	white
54	8.3	0.21	0.49	19.8	0.054	50.0	231.0	1.0012	2.99	0.54	9.2	5	0	white
55	6.9	0.34	0.74	11.2	0.069	44.0	150.0	0.9968	3.0	0.81	9.2	5	0	white
56	6.3	0.27	0.49	1.2	0.063	35.0	92.0	0.9911	3.38	0.42	12.2	6	0	white
57	8.3	0.2	0.74	4.45	0.044	33.0	130.0	0.9924	3.25	0.42	12.2	6	0	white
58	7.1	0.22	0.74	2.7	0.044	42.0	144.0	0.991	3.31	0.41	12.2	6	0	white
59	7.9	0.11	0.49	4.5	0.048	27.0	133.0	0.9946	3.24	0.42	10.6	6	0	white
60	8.5	0.17	0.74	3.6	0.05	29.0	128.0	0.9928	3.28	0.4	12.4	6	0	white
61	6.4	0.145	0.49	5.4	0.048	54.0	164.0	0.9946	3.56	0.44	10.8	6	0	white
62	7.4	0.16	0.49	1.2	0.055	18.0	150.0	0.9917	3.23	0.47	11.2	6	0	white
63	8.3	0.19	0.49	1.2	0.051	11.0	137.0	0.9918	3.06	0.46	11.0	6	0	white
64	8.0	0.44	0.49	9.1	0.031	46.0	151.0	0.9926	3.16	0.27	12.7	8	1	white
65	7.0	0.2	0.74	0.8	0.044	19.0	163.0	0.9931	3.46	0.53	10.2	5	0	white
66	6.9	0.19	0.49	6.6	0.036	49.0	172.0	0.9932	3.2	0.27	11.5	6	0	white
67	7.1	0.25	0.49	3.0	0.03	30.0	96.0	0.9903	3.13	0.39	12.3	7	1	white
68	6.5	0.24	0.24	1.6	0.046	15.0	60.0	0.9928	3.19	0.39	9.8	5	0	white
69	7.2	0.4	0.49	1.1	0.048	11.0	138.0	0.9929	3.01	0.42	9.3	5	0	white
70	7.6	0.52	0.49	14.0	0.034	37.0	156.0	0.9958	3.14	0.38	11.8	7	1	white
71	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white
72	7.8	0.21	0.49	1.35	0.052	6.0	48.0	0.9911	3.15	0.28	11.4	5	0	white
73	7.0	0.2	0.49	5.9	0.038	39.0	128.0	0.9938	3.21	0.48	10.8	6	0	white
74	6.9	0.25	0.24	3.6	0.057	13.0	85.0	0.9942	2.99	0.48	9.5	4	0	white
75	7.2	0.08	0.49	1.3	0.05	18.0	148.0	0.9945	3.46	0.44	10.2	6	0	white
76	7.1	0.85	0.49	8.7	0.028	40.0	184.0	0.9962	3.22	0.36	10.7	5	0	white
77	7.6	0.51	0.24	1.2	0.04	10.0	104.0	0.992	3.05	0.29	10.8	6	0	white
78	7.9	0.22	0.24	4.6	0.044	39.0	159.0	0.9927	2.99	0.28	11.5	6	0	white
79	7.7	0.16	0.49	2.0	0.056	20.0	124.0	0.9948	3.32	0.49	10.7	6	0	white
80	7.2	0.08	0.49	1.3	0.05	18.0	148.0	0.9945	3.46	0.44	10.2	6	0	white
81	6.6	0.25	0.24	1.7	0.048	26.0	124.0	0.9942	3.37	0.6	10.1	6	0	white
82	6.7	0.16	0.49	2.4	0.046	57.0	187.0	0.9952	3.62	0.81	10.4	6	0	white
83	6.9	0.25	0.24	3.6	0.057	13.0	85.0	0.9942	2.99	0.48	9.5	4	0	white
84	7.5	0.32	0.24	4.6	0.053	8.0	134.0	0.9958	3.14	0.5	9.1	3	0	white
85	7.4	0.28	0.49	1.5	0.034	20.0	126.0	0.9918	2.98	0.39	10.6	6	0	white
86	6.2	0.15	0.49	0.9	0.033	17.0	51.0	0.9932	3.3	0.7	9.4	6	0	white
87	6.7	0.25	0.74	19.4	0.054	44.0	169.0	1.0004	3.51	0.45	9.8	6	0	white
88	6.5	0.26	0.74	13.3	0.044	68.0	224.0	0.9972	3.18	0.54	9.5	6	0	white
89	7.9	0.16	0.74	17.85	0.037	52.0	187.0	0.9998	2.99	0.41	9.3	5	0	white
90	5.6	0.185	0.49	1.1	0.03	28.0	117.0	0.9918	3.55	0.45	10.3	6	0	white
91	7.5	0.2	0.49	1.3	0.031	8.0	97.0	0.9918	3.06	0.62	11.1	5	0	white
92	8.0	0.3	0.49	9.4	0.046	47.0	188.0	0.9964	3.14	0.48	10.0	5	0	white
93	8.0	0.34	0.49	9.0	0.033	39.0	180.0	0.9936	3.13	0.38	12.3	8	1	white
94	7.7	0.35	0.49	8.65	0.033	42.0	186.0	0.9931	3.14	0.38	12.4	8	1	white
95	7.6	0.29	0.49	9.6	0.03	45.0	197.0	0.9938	3.13	0.38	12.3	7	1	white
96	6.7	0.62	0.24	1.1	0.039	6.0	62.0	0.9934	3.41	0.32	10.4	5	0	white
97	6.8	0.27	0.49	1.2	0.044	35.0	126.0	0.99	3.13	0.48	12.1	7	1	white
98	7.7	0.27	0.49	1.8	0.041	23.0	86.0	0.9914	3.16	0.42	12.5	6	0	white
99	6.7	0.51	0.24	2.1	0.043	14.0	155.0	0.9904	3.22	0.6	13.0	6	0	white
100	7.4	0.19	0.49	9.3	0.03	26.0	132.0	0.994	2.99	0.32	11.0	7	1	white

Rows: 1-100 | Columns: 14

Note

vastorbit offers a wide range of sample datasets that are ideal for training and testing purposes. You can explore the full list of available datasets in the Datasets, which provides detailed information on each dataset and how to use them effectively. These datasets are invaluable resources for honing your data analysis and machine learning skills within the vastorbit environment.

You can easily divide your dataset into training and testing subsets using the VastFrame.train_test_split() method. This is a crucial step when preparing your data for machine learning, as it allows you to evaluate the performance of your models accurately.

data = vod.load_winequality()
train, test = data.train_test_split(test_size = 0.2)

Warning

In this case, vastorbit utilizes seeded randomization to guarantee the reproducibility of your data split. However, please be aware that this approach may lead to reduced performance. For a more efficient data split, you can use the VastFrame.to_db() method to save your results into tables or temporary tables. This will help enhance the overall performance of the process.

Model Initialization¶

First we import the ElasticNet model:

from vastorbit.machine_learning.vast import ElasticNet

Then we can create the model:

model = ElasticNet(
    tol = 1e-6,
    alpha = 1,
    max_iter = 100,
    l1_ratio = 0.5,
    fit_intercept = True,
)

Important

The model name is crucial for the model management system and versioning. It’s highly recommended to provide a name if you plan to reuse the model later.

Model Training¶

We can now fit the model:

model.fit(
    train,
    [
        "fixed_acidity",
        "volatile_acidity",
        "citric_acid",
        "residual_sugar",
        "chlorides",
        "density",
    ],
    "quality",
    test,
)

Important

To train a model, you can directly use the VastFrame or the name of the relation stored in the database. The test set is optional and is only used to compute the test metrics. In vastorbit, we don’t work using X matrices and y vectors. Instead, we work directly with lists of predictors and the response name.

Metrics¶

We can get the entire report using:

model.report()

	value
explained_variance	-4.440892098500626e-16
max_error	3.1941710094576337
median_absolute_error	0.7353323567135761
mean_absolute_error	0.6889727136034196
mean_squared_error	0.8181429842639966
root_mean_squared_error	0.8763680325741421
r2	-0.0005676871269888473
r2_adj	-0.005153940849496053
aic	-249.98454845124127
bic	-213.86863412676

Rows: 1-10 | Columns: 2

Important

Most metrics are computed using a single SQL query, but some of them might require multiple SQL queries. Selecting only the necessary metrics in the report can help optimize performance. E.g. model.report(metrics = ["mse", "r2"]).

For LinearModel, we can easily get the ANOVA table using:

model.report(metrics = "anova")

	Df	SS	MS	F	p_value
Regression	6	0.23348597221187944	0.03891432870197991	0.048946492889194136	0.9995252216135188
Residual	1309	1040.7049262182668	0.7950381407320601
Total	1315	1038.4468085106537

Rows: 1-3 | Columns: 6

You can also use the LinearModel.score function to compute the R-squared value:

model.score()

Prediction¶

Prediction is straight-forward:

model.predict(
    test,
    [
        "fixed_acidity",
        "volatile_acidity",
        "citric_acid",
        "residual_sugar",
        "chlorides",
        "density",
    ],
    "prediction",
)

	123 fixed_acidity Decimal(6, 3)	123 volatile_acidity Decimal(7, 4)	123 citric_acid Decimal(6, 3)	123 residual_sugar Decimal(7, 3)	123 chlorides Double	123 free_sulfur_dioxide Decimal(7, 2)	123 total_sulfur_dioxide Decimal(7, 2)	123 density Double	123 ph Decimal(6, 3)	123 sulphates Decimal(6, 3)	123 alcohol Double	123 quality Integer	123 good Integer	Abc color Varchar(20)	123 seedrand Decimal(26, 6)	123 prediction Double
1	6.3	0.67	0.48	12.6	0.052	57.0	222.0	0.9979	3.17	0.52	9.3	6	0	white	0.0	5.805828990542366
2	9.0	0.31	0.48	6.6	0.043	11.0	73.0	0.9938	2.9	0.38	11.6	5	0	white	0.17	5.805828990542366
3	7.1	0.26	0.32	5.9	0.037	39.0	97.0	0.9934	3.31	0.4	11.6	6	0	white	0.01	5.805828990542366
4	6.9	0.35	0.74	1.0	0.044	18.0	132.0	0.992	3.13	0.55	10.2	5	0	white	0.0	5.805828990542366
5	6.8	0.22	0.49	0.9	0.052	26.0	128.0	0.991	3.25	0.35	11.4	6	0	white	0.14	5.805828990542366
6	7.2	0.22	0.49	1.0	0.045	34.0	140.0	0.99	3.05	0.34	12.7	6	0	white	0.13	5.805828990542366
7	8.2	0.18	0.49	1.1	0.033	28.0	81.0	0.9923	3.0	0.68	10.4	7	1	white	0.04	5.805828990542366
8	7.2	0.26	0.74	13.6	0.05	56.0	162.0	0.998	3.03	0.44	8.8	5	0	white	0.08	5.805828990542366
9	7.2	0.31	0.24	1.4	0.057	17.0	117.0	0.9928	3.16	0.35	10.5	5	0	white	0.0	5.805828990542366
10	7.4	0.16	0.49	1.2	0.055	18.0	150.0	0.9917	3.23	0.47	11.2	6	0	white	0.2	5.805828990542366
11	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white	0.09	5.805828990542366
12	8.3	0.21	0.49	19.8	0.054	50.0	231.0	1.0012	2.99	0.54	9.2	5	0	white	0.15	5.805828990542366
13	7.4	0.16	0.49	1.2	0.055	18.0	150.0	0.9917	3.23	0.47	11.2	6	0	white	0.1	5.805828990542366
14	8.3	0.19	0.49	1.2	0.051	11.0	137.0	0.9918	3.06	0.46	11.0	6	0	white	0.13	5.805828990542366
15	8.0	0.44	0.49	9.1	0.031	46.0	151.0	0.9926	3.16	0.27	12.7	8	1	white	0.03	5.805828990542366
16	7.8	0.43	0.49	13.0	0.033	37.0	158.0	0.9955	3.14	0.35	11.3	6	0	white	0.18	5.805828990542366
17	7.9	0.22	0.24	4.6	0.044	39.0	159.0	0.9927	2.99	0.28	11.5	6	0	white	0.19	5.805828990542366
18	5.6	0.185	0.49	1.1	0.03	28.0	117.0	0.9918	3.55	0.45	10.3	6	0	white	0.18	5.805828990542366
19	7.5	0.2	0.49	1.3	0.031	8.0	97.0	0.9918	3.06	0.62	11.1	5	0	white	0.17	5.805828990542366
20	7.6	0.29	0.49	9.6	0.03	45.0	197.0	0.9938	3.13	0.38	12.3	7	1	white	0.06	5.805828990542366
21	6.8	0.27	0.49	1.2	0.044	35.0	126.0	0.99	3.13	0.48	12.1	7	1	white	0.19	5.805828990542366
22	7.7	0.27	0.49	1.8	0.041	23.0	86.0	0.9914	3.16	0.42	12.5	6	0	white	0.19	5.805828990542366
23	6.7	0.51	0.24	2.1	0.043	14.0	155.0	0.9904	3.22	0.6	13.0	6	0	white	0.17	5.805828990542366
24	6.8	0.36	0.24	4.6	0.039	24.0	124.0	0.9909	3.27	0.34	12.6	7	1	white	0.16	5.805828990542366
25	7.8	0.26	0.74	7.5	0.044	59.0	160.0	0.996	3.22	0.64	10.0	6	0	white	0.17	5.805828990542366
26	6.6	0.3	0.24	1.2	0.034	17.0	121.0	0.9933	3.13	0.36	9.2	5	0	white	0.11	5.805828990542366
27	7.9	0.28	0.49	7.7	0.045	48.0	195.0	0.9954	3.04	0.55	11.0	6	0	white	0.12	5.805828990542366
28	7.4	0.27	0.49	1.1	0.037	33.0	156.0	0.992	3.15	0.54	11.1	6	0	white	0.02	5.805828990542366
29	7.2	0.27	0.74	12.5	0.037	47.0	156.0	0.9981	3.04	0.44	8.7	5	0	white	0.06	5.805828990542366
30	6.0	0.17	0.49	1.0	0.034	26.0	106.0	0.992	3.21	0.42	9.8	6	0	white	0.11	5.805828990542366
31	7.1	0.18	0.74	15.6	0.044	44.0	176.0	0.9996	3.38	0.67	9.0	6	0	white	0.09	5.805828990542366
32	7.1	0.36	0.24	1.8	0.025	32.0	102.0	0.9903	3.34	0.59	12.8	6	0	white	0.0	5.805828990542366
33	7.9	0.18	0.49	5.2	0.051	36.0	157.0	0.9953	3.18	0.48	10.6	6	0	white	0.18	5.805828990542366
34	8.8	0.35	0.49	1.0	0.036	14.0	56.0	0.992	2.96	0.33	10.5	4	0	white	0.02	5.805828990542366
35	7.1	0.34	0.49	1.5	0.027	26.0	126.0	0.99	3.3	0.33	12.2	7	1	white	0.14	5.805828990542366
36	9.1	0.28	0.49	2.0	0.059	10.0	112.0	0.9958	3.15	0.46	10.1	5	0	white	0.11	5.805828990542366
37	7.4	0.3	0.49	8.2	0.055	49.0	188.0	0.9974	3.52	0.58	9.7	6	0	white	0.03	5.805828990542366
38	7.6	0.31	0.49	13.4	0.062	50.0	191.0	0.9989	3.22	0.53	9.0	4	0	white	0.08	5.805828990542366
39	7.3	0.3	0.74	13.5	0.039	46.0	165.0	0.9982	3.02	0.4	8.7	5	0	white	0.04	5.805828990542366
40	7.0	0.27	0.74	1.5	0.036	27.0	122.0	0.9926	3.35	0.48	11.2	6	0	white	0.1	5.805828990542366
41	6.7	0.33	0.49	1.6	0.167	20.0	94.0	0.9914	3.11	0.5	11.4	6	0	white	0.03	5.805828990542366
42	7.8	0.26	0.49	3.2	0.027	28.0	87.0	0.9919	3.03	0.32	11.3	7	1	white	0.15	5.805828990542366
43	8.0	0.14	0.49	1.5	0.035	42.0	120.0	0.9928	3.26	0.4	10.6	7	1	white	0.2	5.805828990542366
44	6.2	0.2	0.49	1.6	0.065	17.0	143.0	0.9937	3.22	0.52	9.2	6	0	white	0.07	5.805828990542366
45	7.0	0.14	0.49	5.9	0.053	22.0	118.0	0.9954	3.36	0.36	9.4	6	0	white	0.0	5.805828990542366
46	7.4	0.19	0.49	6.7	0.037	15.0	110.0	0.9938	3.2	0.38	11.0	7	1	white	0.02	5.805828990542366
47	7.3	0.19	0.49	15.55	0.058	50.0	134.0	0.9998	3.42	0.36	9.1	7	1	white	0.03	5.805828990542366
48	7.9	0.33	0.28	31.6	0.053	35.0	176.0	1.0103	3.15	0.38	8.8	6	0	white	0.04	5.805828990542366
49	9.9	0.35	0.38	1.5	0.0579999999999999	31.0	47.0	0.99676	3.26	0.82	10.6	7	1	red	0.2	5.805828990542366
50	8.2	0.43	0.29	1.6	0.081	27.0	45.0	0.99603	3.25	0.54	10.3	5	0	red	0.09	5.805828990542366
51	9.6	0.5	0.36	2.8	0.1159999999999999	26.0	55.0	0.99722	3.18	0.68	10.9	5	0	red	0.2	5.805828990542366
52	8.9	0.28	0.45	1.7	0.067	7.0	12.0	0.99354	3.25	0.55	12.3	7	1	red	0.15	5.805828990542366
53	8.9	0.32	0.31	2.0	0.088	12.0	19.0	0.9957	3.17	0.55	10.4	6	0	red	0.01	5.805828990542366
54	7.7	0.58	0.01	1.8	0.088	12.0	18.0	0.99568	3.32	0.56	10.5	7	1	red	0.07	5.805828990542366
55	9.1	0.4	0.5	1.8	0.071	7.0	16.0	0.99462	3.21	0.69	12.5	8	1	red	0.0	5.805828990542366
56	8.0	0.38	0.44	1.9	0.098	6.0	15.0	0.9956	3.3	0.64	11.4	6	0	red	0.13	5.805828990542366
57	8.2	0.74	0.09	2.0	0.067	5.0	10.0	0.99418	3.28	0.57	11.8	6	0	red	0.12	5.805828990542366
58	7.7	0.61	0.18	2.4	0.083	6.0	20.0	0.9963	3.29	0.6	10.2	6	0	red	0.13	5.805828990542366
59	7.2	0.35	0.26	1.8	0.083	33.0	75.0	0.9968	3.4	0.58	9.5	6	0	red	0.17	5.805828990542366
60	8.0	0.62	0.33	2.7	0.088	16.0	37.0	0.9972	3.31	0.58	10.7	6	0	red	0.02	5.805828990542366
61	8.6	0.37	0.65	6.4	0.08	3.0	8.0	0.99817	3.27	0.58	11.0	5	0	red	0.06	5.805828990542366
62	6.8	0.48	0.08	1.8	0.074	40.0	64.0	0.99529	3.12	0.49	9.6	5	0	red	0.17	5.805828990542366
63	8.0	0.31	0.45	2.1	0.216	5.0	16.0	0.99358	3.15	0.81	12.5	7	1	red	0.2	5.805828990542366
64	8.4	0.34	0.42	2.1	0.072	23.0	36.0	0.99392	3.11	0.78	12.4	6	0	red	0.0	5.805828990542366
65	6.1	0.48	0.09	1.7	0.078	18.0	30.0	0.99402	3.45	0.54	11.2	6	0	red	0.17	5.805828990542366
66	8.2	0.23	0.42	1.9	0.069	9.0	17.0	0.99376	3.21	0.54	12.3	6	0	red	0.17	5.805828990542366
67	8.1	0.78	0.1	3.3	0.09	4.0	13.0	0.99855	3.36	0.49	9.5	5	0	red	0.19	5.805828990542366
68	8.3	0.53	0.0	1.4	0.07	6.0	14.0	0.99593	3.25	0.64	10.0	6	0	red	0.09	5.805828990542366
69	7.0	0.69	0.07	2.5	0.091	15.0	21.0	0.99572	3.38	0.6	11.3	6	0	red	0.18	5.805828990542366
70	5.6	0.66	0.0	2.5	0.066	7.0	15.0	0.99256	3.52	0.58	12.9	5	0	red	0.02	5.805828990542366
71	9.1	0.6	0.0	1.9	0.0579999999999999	5.0	10.0	0.9977	3.18	0.63	10.4	6	0	red	0.07	5.805828990542366
72	5.9	0.19	0.21	1.7	0.045	57.0	135.0	0.99341	3.32	0.44	9.5	5	0	red	0.03	5.805828990542366
73	8.0	0.25	0.43	1.7	0.067	22.0	50.0	0.9946	3.38	0.6	11.9	6	0	red	0.12	5.805828990542366
74	10.4	0.52	0.45	2.0	0.08	6.0	13.0	0.99774	3.22	0.76	11.4	6	0	red	0.03	5.805828990542366
75	7.3	0.4	0.3	1.7	0.08	33.0	79.0	0.9969	3.41	0.65	9.5	6	0	red	0.02	5.805828990542366
76	8.3	0.6	0.25	2.2	0.118	9.0	38.0	0.99616	3.15	0.53	9.8	5	0	red	0.05	5.805828990542366
77	10.6	0.36	0.57	2.3	0.087	6.0	20.0	0.99676	3.14	0.72	11.1	7	1	red	0.05	5.805828990542366
78	8.5	0.32	0.42	2.3	0.075	12.0	19.0	0.99434	3.14	0.71	11.8	7	1	red	0.11	5.805828990542366
79	8.5	0.44	0.5	1.9	0.369	15.0	38.0	0.99634	3.01	1.1	9.4	5	0	red	0.2	5.805828990542366
80	6.5	0.34	0.27	2.8	0.067	8.0	44.0	0.99384	3.21	0.56	12.0	6	0	red	0.19	5.805828990542366
81	8.2	0.35	0.33	2.4	0.076	11.0	47.0	0.99599	3.27	0.81	11.0	6	0	red	0.13	5.805828990542366
82	8.2	0.35	0.33	2.4	0.076	11.0	47.0	0.99599	3.27	0.81	11.0	6	0	red	0.04	5.805828990542366
83	6.7	0.64	0.23	2.1	0.08	11.0	119.0	0.99538	3.36	0.7	10.9	5	0	red	0.12	5.805828990542366
84	7.0	0.745	0.12	1.8	0.114	15.0	64.0	0.99588	3.22	0.59	9.5	6	0	red	0.02	5.805828990542366
85	7.7	0.57	0.21	1.5	0.069	4.0	9.0	0.99458	3.16	0.54	9.8	6	0	red	0.0	5.805828990542366
86	7.7	0.26	0.26	2.0	0.052	19.0	77.0	0.9951	3.15	0.79	10.9	6	0	red	0.04	5.805828990542366
87	7.7	0.57	0.21	1.5	0.069	4.0	9.0	0.99458	3.16	0.54	9.8	6	0	red	0.18	5.805828990542366
88	6.8	0.65	0.02	2.1	0.078	8.0	15.0	0.99498	3.35	0.62	10.4	6	0	red	0.01	5.805828990542366
89	10.2	0.33	0.46	1.9	0.081	6.0	9.0	0.99628	3.1	0.48	10.4	6	0	red	0.13	5.805828990542366
90	8.8	0.27	0.46	2.1	0.095	20.0	29.0	0.99488	3.26	0.56	11.3	6	0	red	0.14	5.805828990542366
91	8.2	0.34	0.37	1.9	0.057	43.0	74.0	0.99408	3.23	0.81	12.0	6	0	red	0.04	5.805828990542366
92	10.9	0.32	0.52	1.8	0.132	17.0	44.0	0.99734	3.28	0.77	11.5	6	0	red	0.1	5.805828990542366
93	9.2	0.46	0.23	2.6	0.091	18.0	77.0	0.99922	3.15	0.51	9.4	5	0	red	0.16	5.805828990542366
94	6.0	0.33	0.32	12.9	0.054	6.0	113.0	0.99572	3.3	0.56	11.5	4	0	red	0.12	5.805828990542366
95	7.8	0.55	0.0	1.7	0.07	7.0	17.0	0.99659	3.26	0.64	9.4	6	0	red	0.09	5.805828990542366
96	6.9	0.41	0.33	2.2	0.081	22.0	36.0	0.9949	3.41	0.75	11.1	6	0	red	0.18	5.805828990542366
97	6.1	0.35	0.07	1.4	0.069	22.0	108.0	0.9934	3.23	0.52	9.2	5	0	white	0.14	5.805828990542366
98	6.8	0.22	0.31	6.3	0.035	33.0	170.0	0.9918	3.24	0.66	12.6	6	0	white	0.2	5.805828990542366
99	7.2	0.25	0.39	18.95	0.038	42.0	155.0	0.9999	2.97	0.47	9.0	6	0	white	0.19	5.805828990542366
100	7.4	0.31	0.28	1.6	0.05	33.0	137.0	0.9929	3.31	0.56	10.5	6	0	white	0.06	5.805828990542366

Rows: 1-100 | Columns: 16

Note

Predictions can be made automatically using the test set, in which case you don’t need to specify the predictors. Alternatively, you can pass only the VastFrame to the predict() function, but in this case, it’s essential that the column names of the VastFrame match the predictors and response name in the model.

Plots¶

If the model allows, you can also generate relevant plots. For example, regression plots can be found in the Machine Learning - Regression Plots.

model.plot()

Important

The plotting feature is typically suitable for models with fewer than three predictors.

Parameter Modification¶

In order to see the parameters:

model.get_params()

And to manually change some of the parameters:

model.set_params({'tol': 0.001})

Model Exporting¶

To Memmodel

model.to_memmodel()

Note

MemModel objects serve as in-memory representations of machine learning models. They can be used for both in-database and in-memory prediction tasks. These objects can be pickled in the same way that you would pickle a scikit-learn model.

The following methods for exporting the model use MemModel, and it is recommended to use MemModel directly.

To SQL

You can get the SQL code by:

model.to_sql()

To Python

To obtain the prediction function in Python syntax, use the following code:

X = [[4.2, 0.17, 0.36, 1.8, 0.029, 0.9899]]
model.to_python()(X)

Hint

The to_python() method is used to retrieve predictions, probabilities, or cluster distances. For specific details on how to use this method for different model types, refer to the relevant documentation for each model.

__init__(name: str = None, overwrite_model: bool = False, **kwargs) → None¶

Methods

`__init__`([name, overwrite_model])
`contour`([nbins, chart])	Draws the model's contour plot.
`deploySQL`([X])	Returns the SQL code needed to deploy the model.
`drop`()	Drops the model from the VAST DataBase.
`export_models`(name, path[, kind])	Exports machine learning models.
`features_importance`([show, chart])	Computes the model's features importance.
`fit`(input_relation, X, y[, test_relation, ...])	Trains the model.
`get_attributes`([attr_name])	Returns the model attributes.
`get_match_index`(x, col_list[, str_check])	Returns the matching index.
`get_params`()	Returns the parameters of the model.
`get_plotting_lib`([class_name, chart, ...])	Returns the first available library (Plotly, Matplotlib) to draw a specific graphic.
`import_models`(path[, schema, kind])	Imports machine learning models.
`plot`([max_nb_points, chart])	Draws the model.
`predict`(vdf[, X, name, inplace])	Predicts using the input relation.
`regression_report`([metrics])	Computes a regression report using multiple metrics to evaluate the model (`r2`, `mse`, `max error`...).
`report`([metrics])	Computes a regression report using multiple metrics to evaluate the model (`r2`, `mse`, `max error`...).
`score`([metric])	Computes the model score.
`set_params`([parameters])	Sets the parameters of the model.
`summarize`()	Summarizes the model.
`to_binary`(path)	Exports the model to the VAST Binary format.
`to_memmodel`()	Converts the model to an InMemory object that can be used for different types of predictions.
`to_python`([return_proba, ...])	Returns the Python function needed for in-memory scoring without using built-in VAST functions.
`to_sql`([X, return_proba, ...])	Returns the SQL code needed to deploy the model without using built-in VAST functions.

Attributes

object_type