Feedback

×

• Feedback
• Was this page helpful?*
  • Yes
  • No
• Do you have any additional feedback?
  • Yes
  • No
• Additional Feedback

verticapy.machine_learning.vertica.neighbors.KNeighborsRegressor

class verticapy.machine_learning.vertica.neighbors.KNeighborsRegressor(name: str = None, overwrite_model: bool = False, n_neighbors: int = 5, p: int = 2)

[Beta Version] Creates a KNeighborsRegressor object using the k-nearest neighbors algorithm. This object uses pure SQL to compute all the distances and final score.

Warning

This algorithm uses a CROSS JOIN during computation and is therefore computationally expensive at O(n * n), where n is the total number of elements. Since KNeighborsRegressor uses the p- distance, it is highly sensitive to unnormalized data.

Important

This algorithm is not Vertica Native and relies solely on SQL for attribute computation. While this model does not take advantage of the benefits provided by a model management system, including versioning and tracking, the SQL code it generates can still be used to create a pipeline.

Parameters

n_neighbors: int, optional

Number of neighbors to consider when computing the score.

p: int, optional

The p of the p-distances (distance metric used during the model computation).

Attributes

Many attributes are created during the fitting phase.

n_neighbors_: int

Number of neighbors.

p_: int

The p of the p-distances.

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 verticapy:

import verticapy as vp

Hint

By assigning an alias to verticapy, we mitigate the risk of code collisions with other libraries. This precaution is necessary because verticapy 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 verticapy are used as intended without interfering with functions from other libraries.

For this example, we will use the winequality dataset.

import verticapy.datasets as vpd

data = vpd.load_winequality()

	123 fixed_acidity Numeric(8)	123 volatile_acidity Numeric(9)	123 citric_acid Numeric(8)	123 residual_sugar Numeric(9)	123 chlorides Float(22)	123 free_sulfur_dioxide Numeric(9)	123 total_sulfur_dioxide Numeric(9)	123 density Float(22)	123 pH Numeric(8)	123 sulphates Numeric(8)	123 alcohol Float(22)	123 quality Integer	123 good Integer	Abc color Varchar(20)
1	3.8	0.31	0.02	11.1	0.036	20.0	114.0	0.99248	3.75	0.44	12.4	6	0	white
2	3.9	0.225	0.4	4.2	0.03	29.0	118.0	0.989	3.57	0.36	12.8	8	1	white
3	4.2	0.17	0.36	1.8	0.029	93.0	161.0	0.98999	3.65	0.89	12.0	7	1	white
4	4.2	0.215	0.23	5.1	0.041	64.0	157.0	0.99688	3.42	0.44	8.0	3	0	white
5	4.4	0.32	0.39	4.3	0.03	31.0	127.0	0.98904	3.46	0.36	12.8	8	1	white
6	4.4	0.46	0.1	2.8	0.024	31.0	111.0	0.98816	3.48	0.34	13.1	6	0	white
7	4.4	0.54	0.09	5.1	0.038	52.0	97.0	0.99022	3.41	0.4	12.2	7	1	white
8	4.5	0.19	0.21	0.95	0.033	89.0	159.0	0.99332	3.34	0.42	8.0	5	0	white
9	4.6	0.445	0.0	1.4	0.053	11.0	178.0	0.99426	3.79	0.55	10.2	5	0	white
10	4.6	0.52	0.15	2.1	0.054	8.0	65.0	0.9934	3.9	0.56	13.1	4	0	red
11	4.7	0.145	0.29	1.0	0.042	35.0	90.0	0.9908	3.76	0.49	11.3	6	0	white
12	4.7	0.335	0.14	1.3	0.036	69.0	168.0	0.99212	3.47	0.46	10.5	5	0	white
13	4.7	0.455	0.18	1.9	0.036	33.0	106.0	0.98746	3.21	0.83	14.0	7	1	white
14	4.7	0.6	0.17	2.3	0.058	17.0	106.0	0.9932	3.85	0.6	12.9	6	0	red
15	4.7	0.67	0.09	1.0	0.02	5.0	9.0	0.98722	3.3	0.34	13.6	5	0	white
16	4.7	0.785	0.0	3.4	0.036	23.0	134.0	0.98981	3.53	0.92	13.8	6	0	white
17	4.8	0.13	0.32	1.2	0.042	40.0	98.0	0.9898	3.42	0.64	11.8	7	1	white
18	4.8	0.17	0.28	2.9	0.03	22.0	111.0	0.9902	3.38	0.34	11.3	7	1	white
19	4.8	0.21	0.21	10.2	0.037	17.0	112.0	0.99324	3.66	0.48	12.2	7	1	white
20	4.8	0.225	0.38	1.2	0.074	47.0	130.0	0.99132	3.31	0.4	10.3	6	0	white
21	4.8	0.26	0.23	10.6	0.034	23.0	111.0	0.99274	3.46	0.28	11.5	7	1	white
22	4.8	0.29	0.23	1.1	0.044	38.0	180.0	0.98924	3.28	0.34	11.9	6	0	white
23	4.8	0.33	0.0	6.5	0.028	34.0	163.0	0.9937	3.35	0.61	9.9	5	0	white
24	4.8	0.34	0.0	6.5	0.028	33.0	163.0	0.9939	3.36	0.61	9.9	6	0	white
25	4.8	0.65	0.12	1.1	0.013	4.0	10.0	0.99246	3.32	0.36	13.5	4	0	white
26	4.9	0.235	0.27	11.75	0.03	34.0	118.0	0.9954	3.07	0.5	9.4	6	0	white
27	4.9	0.33	0.31	1.2	0.016	39.0	150.0	0.98713	3.33	0.59	14.0	8	1	white
28	4.9	0.335	0.14	1.3	0.036	69.0	168.0	0.99212	3.47	0.46	10.4666666666667	5	0	white
29	4.9	0.335	0.14	1.3	0.036	69.0	168.0	0.99212	3.47	0.46	10.4666666666667	5	0	white
30	4.9	0.345	0.34	1.0	0.068	32.0	143.0	0.99138	3.24	0.4	10.1	5	0	white
31	4.9	0.345	0.34	1.0	0.068	32.0	143.0	0.99138	3.24	0.4	10.1	5	0	white
32	4.9	0.42	0.0	2.1	0.048	16.0	42.0	0.99154	3.71	0.74	14.0	7	1	red
33	4.9	0.47	0.17	1.9	0.035	60.0	148.0	0.98964	3.27	0.35	11.5	6	0	white
34	5.0	0.17	0.56	1.5	0.026	24.0	115.0	0.9906	3.48	0.39	10.8	7	1	white
35	5.0	0.2	0.4	1.9	0.015	20.0	98.0	0.9897	3.37	0.55	12.05	6	0	white
36	5.0	0.235	0.27	11.75	0.03	34.0	118.0	0.9954	3.07	0.5	9.4	6	0	white
37	5.0	0.24	0.19	5.0	0.043	17.0	101.0	0.99438	3.67	0.57	10.0	5	0	white
38	5.0	0.24	0.21	2.2	0.039	31.0	100.0	0.99098	3.69	0.62	11.7	6	0	white
39	5.0	0.24	0.34	1.1	0.034	49.0	158.0	0.98774	3.32	0.32	13.1	7	1	white
40	5.0	0.255	0.22	2.7	0.043	46.0	153.0	0.99238	3.75	0.76	11.3	6	0	white
41	5.0	0.27	0.32	4.5	0.032	58.0	178.0	0.98956	3.45	0.31	12.6	7	1	white
42	5.0	0.27	0.32	4.5	0.032	58.0	178.0	0.98956	3.45	0.31	12.6	7	1	white
43	5.0	0.27	0.4	1.2	0.076	42.0	124.0	0.99204	3.32	0.47	10.1	6	0	white
44	5.0	0.29	0.54	5.7	0.035	54.0	155.0	0.98976	3.27	0.34	12.9	8	1	white
45	5.0	0.3	0.33	3.7	0.03	54.0	173.0	0.9887	3.36	0.3	13.0	7	1	white
46	5.0	0.31	0.0	6.4	0.046	43.0	166.0	0.994	3.3	0.63	9.9	6	0	white
47	5.0	0.33	0.16	1.5	0.049	10.0	97.0	0.9917	3.48	0.44	10.7	6	0	white
48	5.0	0.33	0.16	1.5	0.049	10.0	97.0	0.9917	3.48	0.44	10.7	6	0	white
49	5.0	0.33	0.16	1.5	0.049	10.0	97.0	0.9917	3.48	0.44	10.7	6	0	white
50	5.0	0.33	0.18	4.6	0.032	40.0	124.0	0.99114	3.18	0.4	11.0	6	0	white
51	5.0	0.33	0.23	11.8	0.03	23.0	158.0	0.99322	3.41	0.64	11.8	6	0	white
52	5.0	0.35	0.25	7.8	0.031	24.0	116.0	0.99241	3.39	0.4	11.3	6	0	white
53	5.0	0.35	0.25	7.8	0.031	24.0	116.0	0.99241	3.39	0.4	11.3	6	0	white
54	5.0	0.38	0.01	1.6	0.048	26.0	60.0	0.99084	3.7	0.75	14.0	6	0	red
55	5.0	0.4	0.5	4.3	0.046	29.0	80.0	0.9902	3.49	0.66	13.6	6	0	red
56	5.0	0.42	0.24	2.0	0.06	19.0	50.0	0.9917	3.72	0.74	14.0	8	1	red
57	5.0	0.44	0.04	18.6	0.039	38.0	128.0	0.9985	3.37	0.57	10.2	6	0	white
58	5.0	0.455	0.18	1.9	0.036	33.0	106.0	0.98746	3.21	0.83	14.0	7	1	white
59	5.0	0.55	0.14	8.3	0.032	35.0	164.0	0.9918	3.53	0.51	12.5	8	1	white
60	5.0	0.61	0.12	1.3	0.009	65.0	100.0	0.9874	3.26	0.37	13.5	5	0	white
61	5.0	0.74	0.0	1.2	0.041	16.0	46.0	0.99258	4.01	0.59	12.5	6	0	red
62	5.0	1.02	0.04	1.4	0.045	41.0	85.0	0.9938	3.75	0.48	10.5	4	0	red
63	5.0	1.04	0.24	1.6	0.05	32.0	96.0	0.9934	3.74	0.62	11.5	5	0	red
64	5.1	0.11	0.32	1.6	0.028	12.0	90.0	0.99008	3.57	0.52	12.2	6	0	white
65	5.1	0.14	0.25	0.7	0.039	15.0	89.0	0.9919	3.22	0.43	9.2	6	0	white
66	5.1	0.165	0.22	5.7	0.047	42.0	146.0	0.9934	3.18	0.55	9.9	6	0	white
67	5.1	0.21	0.28	1.4	0.047	48.0	148.0	0.99168	3.5	0.49	10.4	5	0	white
68	5.1	0.23	0.18	1.0	0.053	13.0	99.0	0.98956	3.22	0.39	11.5	5	0	white
69	5.1	0.25	0.36	1.3	0.035	40.0	78.0	0.9891	3.23	0.64	12.1	7	1	white
70	5.1	0.26	0.33	1.1	0.027	46.0	113.0	0.98946	3.35	0.43	11.4	7	1	white
71	5.1	0.26	0.34	6.4	0.034	26.0	99.0	0.99449	3.23	0.41	9.2	6	0	white
72	5.1	0.29	0.28	8.3	0.026	27.0	107.0	0.99308	3.36	0.37	11.0	6	0	white
73	5.1	0.29	0.28	8.3	0.026	27.0	107.0	0.99308	3.36	0.37	11.0	6	0	white
74	5.1	0.3	0.3	2.3	0.048	40.0	150.0	0.98944	3.29	0.46	12.2	6	0	white
75	5.1	0.305	0.13	1.75	0.036	17.0	73.0	0.99	3.4	0.51	12.3333333333333	5	0	white
76	5.1	0.31	0.3	0.9	0.037	28.0	152.0	0.992	3.54	0.56	10.1	6	0	white
77	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
78	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
79	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
80	5.1	0.33	0.27	6.7	0.022	44.0	129.0	0.99221	3.36	0.39	11.0	7	1	white
81	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
82	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
83	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
84	5.1	0.39	0.21	1.7	0.027	15.0	72.0	0.9894	3.5	0.45	12.5	6	0	white
85	5.1	0.42	0.0	1.8	0.044	18.0	88.0	0.99157	3.68	0.73	13.6	7	1	red
86	5.1	0.42	0.01	1.5	0.017	25.0	102.0	0.9894	3.38	0.36	12.3	7	1	white
87	5.1	0.47	0.02	1.3	0.034	18.0	44.0	0.9921	3.9	0.62	12.8	6	0	red
88	5.1	0.51	0.18	2.1	0.042	16.0	101.0	0.9924	3.46	0.87	12.9	7	1	red
89	5.1	0.52	0.06	2.7	0.052	30.0	79.0	0.9932	3.32	0.43	9.3	5	0	white
90	5.1	0.585	0.0	1.7	0.044	14.0	86.0	0.99264	3.56	0.94	12.9	7	1	red
91	5.2	0.155	0.33	1.6	0.028	13.0	59.0	0.98975	3.3	0.84	11.9	8	1	white
92	5.2	0.155	0.33	1.6	0.028	13.0	59.0	0.98975	3.3	0.84	11.9	8	1	white
93	5.2	0.16	0.34	0.8	0.029	26.0	77.0	0.99155	3.25	0.51	10.1	6	0	white
94	5.2	0.17	0.27	0.7	0.03	11.0	68.0	0.99218	3.3	0.41	9.8	5	0	white
95	5.2	0.185	0.22	1.0	0.03	47.0	123.0	0.99218	3.55	0.44	10.15	6	0	white
96	5.2	0.2	0.27	3.2	0.047	16.0	93.0	0.99235	3.44	0.53	10.1	7	1	white
97	5.2	0.21	0.31	1.7	0.048	17.0	61.0	0.98953	3.24	0.37	12.0	7	1	white
98	5.2	0.22	0.46	6.2	0.066	41.0	187.0	0.99362	3.19	0.42	9.73333333333333	5	0	white
99	5.2	0.24	0.15	7.1	0.043	32.0	134.0	0.99378	3.24	0.48	9.9	6	0	white
100	5.2	0.24	0.45	3.8	0.027	21.0	128.0	0.992	3.55	0.49	11.2	8	1	white

Rows: 1-100 | Columns: 14

Note

VerticaPy 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 VerticaPy environment.

You can easily divide your dataset into training and testing subsets using the vDataFrame.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.

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

Warning

In this case, VerticaPy 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 vDataFrame.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 KNeighborsRegressor model:

from verticapy.machine_learning.vertica import KNeighborsRegressor

Then we can create the model:

model = KNeighborsRegressor()

Hint

In verticapy 1.0.x and higher, you do not need to specify the model name, as the name is automatically assigned. If you need to re-use the model, you can fetch the model name from the model’s attributes.

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 vDataFrame 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 verticapy, 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:

result = model.report()

	value
explained_variance	0.318042968486921
max_error	2.8
median_absolute_error	0.4
mean_absolute_error	0.562403697996918
mean_squared_error	0.530539291217257
root_mean_squared_error	0.728381281484675
r2	0.315909360860594
r2_adj	0.31273000854856
aic	-808.589123705928
bic	-772.571855122754

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 KNeighborsRegressor, we can easily get the ANOVA table using:

result = model.report(metrics = "anova")

	Df	SS	MS	F	p_value
Regression	6	350.476671802774	58.41277863379566	109.50699526055732	8.628875717315005e-112
Residual	1291	688.64	0.5334159566227731
Total	1297	1006.65023112481

Rows: 1-3 | Columns: 6

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

model.score()
Out[4]: 0.315909360860594

Prediction

Prediction is straight-forward:

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

	123 fixed_acidity Numeric(8)	123 volatile_acidity Numeric(9)	123 citric_acid Numeric(8)	123 residual_sugar Numeric(9)	123 chlorides Float(22)	123 density Float(22)	123 free_sulfur_dioxide Numeric(9)	123 total_sulfur_dioxide Numeric(9)	123 pH Numeric(8)	123 sulphates Numeric(8)	123 alcohol Float(22)	123 quality Integer	123 good Integer	Abc color Varchar(20)	123 prediction Float(22)
1	7.0	0.28	0.26	1.7	0.042	0.9925	34.0	130.0	3.43	0.5	10.7	8	1	white	6.4
2	6.5	0.46	0.14	2.4	0.114	0.99732	9.0	37.0	3.66	0.65	9.8	5	0	red	6.0
3	5.3	0.24	0.33	1.3	0.033	0.9906	25.0	97.0	3.59	0.38	11.0	8	1	white	6.8
4	8.1	0.33	0.36	7.4	0.037	0.99592	36.0	156.0	3.19	0.54	10.6	6	0	white	5.8
5	6.8	0.15	0.33	4.7	0.059	0.9956	31.0	118.0	3.43	0.39	9.0	7	1	white	6.2
6	7.2	0.19	0.31	6.3	0.034	0.99305	17.0	103.0	3.15	0.52	11.4	7	1	white	6.4
7	5.4	0.205	0.16	12.55	0.051	0.99564	31.0	115.0	3.4	0.38	10.8	6	0	white	6.0
8	6.1	0.16	0.27	12.6	0.064	0.9994	63.0	162.0	3.66	0.43	8.9	5	0	white	5.4
9	6.4	0.33	0.3	7.2	0.041	0.99331	42.0	168.0	3.22	0.49	11.1	6	0	white	6.4
10	7.3	0.18	0.29	1.2	0.044	0.9918	12.0	143.0	3.2	0.48	11.3	7	1	white	6.2
11	7.5	0.27	0.31	5.8	0.057	0.9946	131.0	313.0	3.18	0.59	10.5	5	0	white	6.0
12	4.7	0.335	0.14	1.3	0.036	0.99212	69.0	168.0	3.47	0.46	10.5	5	0	white	5.6
13	11.9	0.38	0.49	2.7	0.098	1.0004	12.0	42.0	3.16	0.61	10.3	5	0	red	5.6
14	5.4	0.255	0.33	1.2	0.051	0.99048	29.0	122.0	3.37	0.66	11.3	6	0	white	6.4
15	7.3	0.25	0.28	1.5	0.043	0.99338	19.0	113.0	3.38	0.56	10.1	6	0	white	5.8
16	5.7	0.26	0.24	17.8	0.059	0.99773	23.0	124.0	3.3	0.5	10.1	5	0	white	5.4
17	7.2	0.31	0.35	7.2	0.046	0.9955	45.0	178.0	3.14	0.53	9.7	5	0	white	5.8
18	7.4	0.16	0.3	13.7	0.056	0.99825	33.0	168.0	2.9	0.44	8.7	7	1	white	7.0
19	6.8	0.15	0.41	12.9	0.044	0.99742	79.5	182.0	3.24	0.78	10.2	6	0	white	6.2
20	12.0	0.28	0.49	1.9	0.074	0.9976	10.0	21.0	2.98	0.66	9.9	7	1	red	6.0
21	7.4	0.29	0.38	1.7	0.062	0.9968	9.0	30.0	3.41	0.53	9.5	6	0	red	5.8
22	7.1	0.16	0.44	2.5	0.068	0.99328	17.0	31.0	3.35	0.54	12.4	6	0	red	6.4
23	6.6	0.39	0.49	1.7	0.07	0.9922	23.0	149.0	3.12	0.5	11.5	6	0	red	6.4
24	6.0	0.28	0.29	19.3	0.051	0.99911	36.0	174.0	3.14	0.5	9.0	5	0	white	5.4
25	6.3	0.2	0.24	1.7	0.052	0.99374	36.0	135.0	3.8	0.66	10.8	6	0	white	6.2
26	7.1	0.22	0.32	16.9	0.056	0.9998	49.0	158.0	3.37	0.38	9.6	6	0	white	6.0
27	6.5	0.28	0.25	4.8	0.029	0.99074	54.0	128.0	3.17	0.44	12.2	7	1	white	6.2
28	6.1	0.6	0.12	1.8	0.05	0.99268	11.0	76.0	3.42	0.48	10.4	4	0	white	5.2
29	6.8	0.41	0.3	8.8	0.045	0.9953	28.0	131.0	3.12	0.59	9.9	5	0	white	5.6
30	6.6	0.24	0.28	1.8	0.028	0.99182	39.0	132.0	3.34	0.46	11.4	5	0	white	5.6
31	7.0	0.15	0.29	16.4	0.058	0.9978	45.0	110.0	3.15	0.37	9.7	6	0	white	5.4
32	7.6	0.51	0.15	2.8	0.11	0.9955	33.0	73.0	3.17	0.63	10.2	6	0	red	5.4
33	8.1	0.5	0.47	1.1	0.037	0.9938	23.0	126.0	3.21	0.42	10.9	5	0	white	5.4
34	6.6	0.34	0.18	6.4	0.082	0.9971	47.0	240.0	3.42	0.48	9.2	5	0	white	5.4
35	4.9	0.33	0.31	1.2	0.016	0.98713	39.0	150.0	3.33	0.59	14.0	8	1	white	6.6
36	6.1	0.23	0.27	9.8	0.055	0.99534	74.0	134.0	3.16	0.4	10.2	6	0	white	6.2
37	7.6	0.2	0.34	1.8	0.041	0.99335	42.0	148.0	3.35	0.66	11.1	6	0	white	6.2
38	6.6	0.21	0.36	0.8	0.034	0.99165	48.0	113.0	3.24	0.68	10.5	6	0	white	6.2
39	6.6	0.34	0.27	6.2	0.059	0.9957	23.0	136.0	3.3	0.49	10.1	6	0	white	5.4
40	6.6	0.24	0.27	1.4	0.057	0.9934	33.0	152.0	3.22	0.56	9.5	6	0	white	6.0
41	7.2	0.23	0.32	8.5	0.058	0.9956	47.0	186.0	3.19	0.4	9.9	6	0	white	5.6
42	6.6	0.22	0.29	14.4	0.046	0.99834	39.0	118.0	3.05	0.5	9.1	6	0	white	6.0
43	5.8	0.28	0.18	1.2	0.058	0.99288	7.0	108.0	3.23	0.58	9.55	4	0	white	5.6
44	7.3	0.24	0.39	3.6	0.024	0.9928	35.0	116.0	3.17	0.51	10.9	5	0	white	5.6
45	7.3	0.25	0.29	7.5	0.049	0.9965	38.0	158.0	3.43	0.38	9.6	5	0	white	5.6
46	6.8	0.27	0.28	7.8	0.038	0.9915	26.0	89.0	3.24	0.34	12.5	6	0	white	6.0
47	5.9	0.32	0.2	14.4	0.05	0.99666	29.0	144.0	3.24	0.41	10.3	6	0	white	5.8
48	7.5	0.17	0.44	11.3	0.046	0.997	65.0	146.0	3.17	0.45	10.0	6	0	white	5.4
49	7.1	0.36	0.28	2.4	0.036	0.98936	35.0	115.0	3.19	0.44	13.5	7	1	white	6.2
50	7.6	0.18	0.28	7.1	0.041	0.99652	29.0	110.0	3.2	0.42	9.2	6	0	white	6.0
51	6.5	0.3	0.27	4.0	0.038	0.99026	37.0	97.0	3.2	0.6	12.6	8	1	white	6.6
52	8.0	0.22	0.32	10.4	0.043	0.997	63.0	201.0	3.11	0.53	9.5	6	0	white	6.0
53	7.6	0.2	0.68	12.9	0.042	0.99841	56.0	160.0	3.05	0.41	8.7	5	0	white	5.4
54	6.4	0.15	0.36	1.8	0.034	0.9922	43.0	150.0	3.42	0.69	11.0	8	1	white	6.2
55	6.9	0.17	0.22	4.6	0.064	0.9952	55.0	152.0	3.29	0.37	9.3	6	0	white	6.2
56	7.4	0.22	0.33	2.0	0.045	0.9931	31.0	101.0	3.42	0.55	11.4	5	0	white	6.4
57	8.0	0.19	0.36	1.8	0.05	0.9936	16.0	84.0	3.15	0.45	9.8	7	1	white	5.8
58	6.7	0.12	0.36	2.3	0.039	0.99229	43.0	125.0	3.07	0.67	10.1	7	1	white	7.0
59	7.3	0.2	0.44	1.4	0.045	0.9924	21.0	98.0	3.15	0.46	10.0	7	1	white	6.4
60	6.1	0.29	0.27	1.7	0.024	0.9893	13.0	76.0	3.21	0.51	12.6	7	1	white	6.6
61	7.0	0.17	0.37	1.5	0.028	0.9922	26.0	75.0	3.3	0.46	10.8	7	1	white	6.2
62	5.9	0.24	0.28	1.3	0.032	0.98889	36.0	95.0	3.08	0.64	12.9	7	1	white	6.2
63	7.4	0.2	0.31	1.6	0.038	0.9912	34.0	116.0	3.25	0.39	12.0	7	1	white	6.6
64	6.8	0.27	0.3	13.0	0.047	0.99705	69.0	160.0	3.16	0.5	9.6	6	0	white	6.0
65	10.2	0.23	0.37	2.2	0.057	0.99614	14.0	36.0	3.23	0.49	9.3	4	0	red	5.2
66	9.0	0.31	0.49	6.9	0.034	0.9937	26.0	91.0	2.99	0.34	11.5	5	0	white	5.4
67	6.1	0.22	0.5	6.6	0.045	0.99415	30.0	122.0	3.22	0.49	9.9	6	0	white	5.8
68	7.7	0.965	0.1	2.1	0.112	0.9963	11.0	22.0	3.26	0.5	9.5	5	0	red	5.4
69	8.0	0.27	0.33	1.2	0.05	0.99002	41.0	103.0	3.0	0.45	12.4	6	0	white	5.6
70	6.8	0.36	0.32	1.6	0.039	0.9948	10.0	124.0	3.3	0.67	9.6	5	0	white	5.6
71	5.7	0.16	0.26	6.3	0.043	0.9936	28.0	113.0	3.06	0.58	9.9	6	0	white	5.2
72	10.4	0.33	0.63	2.8	0.084	0.9998	5.0	22.0	3.26	0.74	11.2	7	1	red	6.0
73	5.8	0.33	0.2	16.05	0.047	0.9976	26.0	166.0	3.09	0.46	8.9	5	0	white	5.8
74	5.7	0.25	0.26	12.5	0.049	0.99691	52.5	120.0	3.08	0.45	9.4	6	0	white	5.8
75	7.8	0.19	0.32	7.4	0.015	0.99278	47.0	124.0	2.99	0.39	11.0	6	0	white	6.0
76	6.0	0.5	0.0	1.4	0.057	0.99448	15.0	26.0	3.36	0.45	9.5	5	0	red	5.0
77	6.8	0.32	0.37	3.4	0.023	0.9902	19.0	87.0	3.14	0.53	12.7	6	0	white	6.0
78	6.5	0.24	0.39	17.3	0.052	0.99888	22.0	126.0	3.11	0.47	9.2	6	0	white	6.0
79	7.1	0.59	0.01	2.5	0.077	0.99746	20.0	85.0	3.55	0.59	9.8	5	0	red	5.4
80	6.8	0.25	0.29	2.0	0.042	0.9952	19.0	189.0	3.46	0.54	10.2	6	0	white	6.4
81	5.6	0.13	0.27	4.8	0.028	0.9948	22.0	104.0	3.34	0.45	9.2	6	0	white	6.0
82	6.6	0.34	0.4	8.1	0.046	0.99494	68.0	170.0	3.15	0.5	9.55	6	0	white	5.6
83	6.3	0.37	0.28	6.3	0.034	0.9921	45.0	152.0	3.29	0.46	11.6	7	1	white	6.2
84	6.0	0.26	0.15	1.2	0.053	0.99347	35.0	124.0	3.08	0.46	8.8	5	0	white	5.4
85	10.6	0.36	0.57	2.3	0.087	0.99676	6.0	20.0	3.14	0.72	11.1	7	1	red	5.8
86	5.6	0.295	0.2	2.2	0.049	0.99378	18.0	134.0	3.21	0.68	10.0	5	0	white	6.2
87	6.8	0.24	0.4	1.8	0.047	0.99	34.0	105.0	3.13	0.49	12.8	8	1	white	6.8
88	7.8	0.56	0.19	2.0	0.081	0.9962	17.0	108.0	3.32	0.54	9.5	5	0	red	5.2
89	7.3	0.26	0.3	9.3	0.05	0.99581	35.0	154.0	3.21	0.5	10.4	6	0	white	6.0
90	8.3	0.14	0.26	1.5	0.049	0.9946	56.0	189.0	3.21	0.62	9.5	6	0	white	6.2
91	5.9	0.21	0.28	4.6	0.053	0.9964	40.0	199.0	3.72	0.7	10.0	4	0	white	6.2
92	7.4	0.21	0.27	7.3	0.031	0.9932	41.0	144.0	3.15	0.38	11.8	7	1	white	6.2
93	8.0	0.52	0.25	2.0	0.078	0.99612	19.0	59.0	3.3	0.48	10.2	5	0	red	5.8
94	9.3	0.27	0.41	2.0	0.091	0.998	6.0	16.0	3.28	0.7	9.7	5	0	red	4.6
95	7.3	0.26	0.32	1.2	0.041	0.98978	29.0	94.0	3.07	0.45	12.0	6	0	white	5.8
96	9.1	0.22	0.24	2.1	0.078	0.999	1.0	28.0	3.41	0.87	10.3	6	0	red	6.6
97	6.4	0.24	0.23	2.0	0.046	0.9908	30.0	133.0	3.12	0.54	11.4	7	1	white	5.4
98	8.8	0.6	0.29	2.2	0.098	0.9988	5.0	15.0	3.36	0.49	9.1	5	0	red	5.2
99	6.8	0.29	0.16	1.4	0.038	0.9922	122.5	234.5	3.15	0.47	10.0	4	0	white	4.8
100	6.6	0.16	0.57	1.1	0.13	0.9927	58.0	140.0	3.12	0.39	9.3	7	1	white	6.2

Rows: 1-100 | Columns: 15

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 vDataFrame to the predict() function, but in this case, it’s essential that the column names of the vDataFrame match the predictors and response name in the model.

Parameter Modification

In order to see the parameters:

model.get_params()
Out[5]: {'n_neighbors': 5, 'p': 2}

And to manually change some of the parameters:

model.set_params({'n_neighbors': 3})

Model Register

In order to register the model for tracking and versioning:

model.register("model_v1")

Please refer to Model Tracking and Versioning for more details on model tracking and versioning.

__init__(name: str = None, overwrite_model: bool = False, n_neighbors: int = 5, p: int = 2) → None

Must be overridden in the child class

Methods

__init__([name, overwrite_model, n_neighbors, p])	Must be overridden in the child class
contour([nbins, chart])	Draws the model's contour plot.
deploySQL([X, test_relation, key_columns])	Returns the SQL code needed to deploy the model.
does_model_exists(name[, raise_error, ...])	Checks whether the model is stored in the Vertica database.
drop()	KNeighborsRegressor models are not stored in the Vertica DB.
export_models(name, path[, kind])	Exports machine learning models.
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, or Highcharts) to draw a specific graphic.
get_vertica_attributes([attr_name])	Returns the model Vertica attributes.
import_models(path[, schema, kind])	Imports machine learning models.
predict(vdf[, X, name, inplace])	Predicts using the input relation.
register(registered_name[, raise_error])	Registers the model and adds it to in-DB Model versioning environment with a status of 'under_review'.
regression_report([metrics])	Computes a regression report
report([metrics])	Computes a regression report
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 Vertica Binary format.
to_pmml(path)	Exports the model to PMML.
to_python([return_proba, ...])	Returns the Python function needed for in-memory scoring without using built-in Vertica functions.
to_sql([X, return_proba, ...])	Returns the SQL code needed to deploy the model without using built-in Vertica functions.
to_tf(path)	Exports the model to the Frozen Graph format (TensorFlow).

Attributes

object_type