Model.predict¶

In [ ]:

Model.predict(vdf: Union[str, vDataFrame],
              X: list = [],
              name: str = "",
              inplace: bool = True,)

Makes a prediction using the input relation.

Parameters¶

Name	Type	Optional	Description
vdf	str / vDataFrame	❌	Object to use to run the prediction. This can also be a customized relation, but you must use an alias. For example, "(SELECT 1) x" is correct whereas "(SELECT 1)" or "SELECT 1" are incorrect.
X	list	✓	List of the columns used to deploy the models. If empty, the model predictors are used.
name	str	✓	Name of the added vcolumn. If empty, a name is generated.
inplace	bool	✓	If set to True, the prediction is added to the vDataFrame.

Returns¶

vDataFrame : the vDataFrame including the prediction.

Example¶

In [5]:

from verticapy import vDataFrame
iris = vDataFrame("public.iris")
display(iris)

	123 SepalLengthCm Numeric(5,2)	123 SepalWidthCm Numeric(5,2)	123 PetalLengthCm Numeric(5,2)	123 PetalWidthCm Numeric(5,2)	Abc Species Varchar(30)
1	4.30	3.00	1.10	0.10	Iris-setosa
2	4.40	2.90	1.40	0.20	Iris-setosa
3	4.40	3.00	1.30	0.20	Iris-setosa
4	4.40	3.20	1.30	0.20	Iris-setosa
5	4.50	2.30	1.30	0.30	Iris-setosa
6	4.60	3.10	1.50	0.20	Iris-setosa
7	4.60	3.20	1.40	0.20	Iris-setosa
8	4.60	3.40	1.40	0.30	Iris-setosa
9	4.60	3.60	1.00	0.20	Iris-setosa
10	4.70	3.20	1.30	0.20	Iris-setosa
11	4.70	3.20	1.60	0.20	Iris-setosa
12	4.80	3.00	1.40	0.10	Iris-setosa
13	4.80	3.00	1.40	0.30	Iris-setosa
14	4.80	3.10	1.60	0.20	Iris-setosa
15	4.80	3.40	1.60	0.20	Iris-setosa
16	4.80	3.40	1.90	0.20	Iris-setosa
17	4.90	2.40	3.30	1.00	Iris-versicolor
18	4.90	2.50	4.50	1.70	Iris-virginica
19	4.90	3.00	1.40	0.20	Iris-setosa
20	4.90	3.10	1.50	0.10	Iris-setosa
21	4.90	3.10	1.50	0.10	Iris-setosa
22	4.90	3.10	1.50	0.10	Iris-setosa
23	5.00	2.00	3.50	1.00	Iris-versicolor
24	5.00	2.30	3.30	1.00	Iris-versicolor
25	5.00	3.00	1.60	0.20	Iris-setosa
26	5.00	3.20	1.20	0.20	Iris-setosa
27	5.00	3.30	1.40	0.20	Iris-setosa
28	5.00	3.40	1.50	0.20	Iris-setosa
29	5.00	3.40	1.60	0.40	Iris-setosa
30	5.00	3.50	1.30	0.30	Iris-setosa
31	5.00	3.50	1.60	0.60	Iris-setosa
32	5.00	3.60	1.40	0.20	Iris-setosa
33	5.10	2.50	3.00	1.10	Iris-versicolor
34	5.10	3.30	1.70	0.50	Iris-setosa
35	5.10	3.40	1.50	0.20	Iris-setosa
36	5.10	3.50	1.40	0.20	Iris-setosa
37	5.10	3.50	1.40	0.30	Iris-setosa
38	5.10	3.70	1.50	0.40	Iris-setosa
39	5.10	3.80	1.50	0.30	Iris-setosa
40	5.10	3.80	1.60	0.20	Iris-setosa
41	5.10	3.80	1.90	0.40	Iris-setosa
42	5.20	2.70	3.90	1.40	Iris-versicolor
43	5.20	3.40	1.40	0.20	Iris-setosa
44	5.20	3.50	1.50	0.20	Iris-setosa
45	5.20	4.10	1.50	0.10	Iris-setosa
46	5.30	3.70	1.50	0.20	Iris-setosa
47	5.40	3.00	4.50	1.50	Iris-versicolor
48	5.40	3.40	1.50	0.40	Iris-setosa
49	5.40	3.40	1.70	0.20	Iris-setosa
50	5.40	3.70	1.50	0.20	Iris-setosa
51	5.40	3.90	1.30	0.40	Iris-setosa
52	5.40	3.90	1.70	0.40	Iris-setosa
53	5.50	2.30	4.00	1.30	Iris-versicolor
54	5.50	2.40	3.70	1.00	Iris-versicolor
55	5.50	2.40	3.80	1.10	Iris-versicolor
56	5.50	2.50	4.00	1.30	Iris-versicolor
57	5.50	2.60	4.40	1.20	Iris-versicolor
58	5.50	3.50	1.30	0.20	Iris-setosa
59	5.50	4.20	1.40	0.20	Iris-setosa
60	5.60	2.50	3.90	1.10	Iris-versicolor
61	5.60	2.70	4.20	1.30	Iris-versicolor
62	5.60	2.80	4.90	2.00	Iris-virginica
63	5.60	2.90	3.60	1.30	Iris-versicolor
64	5.60	3.00	4.10	1.30	Iris-versicolor
65	5.60	3.00	4.50	1.50	Iris-versicolor
66	5.70	2.50	5.00	2.00	Iris-virginica
67	5.70	2.60	3.50	1.00	Iris-versicolor
68	5.70	2.80	4.10	1.30	Iris-versicolor
69	5.70	2.80	4.50	1.30	Iris-versicolor
70	5.70	2.90	4.20	1.30	Iris-versicolor
71	5.70	3.00	4.20	1.20	Iris-versicolor
72	5.70	3.80	1.70	0.30	Iris-setosa
73	5.70	4.40	1.50	0.40	Iris-setosa
74	5.80	2.60	4.00	1.20	Iris-versicolor
75	5.80	2.70	3.90	1.20	Iris-versicolor
76	5.80	2.70	4.10	1.00	Iris-versicolor
77	5.80	2.70	5.10	1.90	Iris-virginica
78	5.80	2.70	5.10	1.90	Iris-virginica
79	5.80	2.80	5.10	2.40	Iris-virginica
80	5.80	4.00	1.20	0.20	Iris-setosa
81	5.90	3.00	4.20	1.50	Iris-versicolor
82	5.90	3.00	5.10	1.80	Iris-virginica
83	5.90	3.20	4.80	1.80	Iris-versicolor
84	6.00	2.20	4.00	1.00	Iris-versicolor
85	6.00	2.20	5.00	1.50	Iris-virginica
86	6.00	2.70	5.10	1.60	Iris-versicolor
87	6.00	2.90	4.50	1.50	Iris-versicolor
88	6.00	3.00	4.80	1.80	Iris-virginica
89	6.00	3.40	4.50	1.60	Iris-versicolor
90	6.10	2.60	5.60	1.40	Iris-virginica
91	6.10	2.80	4.00	1.30	Iris-versicolor
92	6.10	2.80	4.70	1.20	Iris-versicolor
93	6.10	2.90	4.70	1.40	Iris-versicolor
94	6.10	3.00	4.60	1.40	Iris-versicolor
95	6.10	3.00	4.90	1.80	Iris-virginica
96	6.20	2.20	4.50	1.50	Iris-versicolor
97	6.20	2.80	4.80	1.80	Iris-virginica
98	6.20	2.90	4.30	1.30	Iris-versicolor
99	6.20	3.40	5.40	2.30	Iris-virginica
100	6.30	2.30	4.40	1.30	Iris-versicolor

Rows: 1-100 of 150 | Columns: 5

In [8]:

from verticapy.learn.neighbors import KNeighborsRegressor
model = KNeighborsRegressor(name = "public.KNN_iris")
model.fit("public.iris", ["PetalLengthCm", "PetalWidthCm"], "SepalLengthCm")
model.predict(iris, 
              X = ["PetalLengthCm", "PetalWidthCm"],
              name = "iris_prediction")

	123 PetalLengthCm Numeric(5,2)	123 PetalWidthCm Numeric(5,2)	123 SepalLengthCm Numeric(5,2)	123 SepalWidthCm Numeric(5,2)	Abc Species Varchar(30)	123 iris_prediction Float
1	1.50	0.20	4.60	3.10	Iris-setosa	5.04
2	1.40	0.20	5.00	3.60	Iris-setosa	4.78
3	1.60	0.20	5.10	3.80	Iris-setosa	4.88
4	5.60	1.40	6.10	2.60	Iris-virginica	6.5
5	3.90	1.40	5.20	2.70	Iris-versicolor	5.62
6	4.10	1.30	5.70	2.80	Iris-versicolor	5.58
7	4.50	1.50	6.20	2.20	Iris-versicolor	5.92
8	4.00	1.30	5.50	2.50	Iris-versicolor	5.68
9	4.60	1.50	6.50	2.80	Iris-versicolor	5.92
10	1.90	0.20	4.80	3.40	Iris-setosa	5.28
11	4.70	1.60	6.30	3.30	Iris-versicolor	6.32
12	4.00	1.00	6.00	2.20	Iris-versicolor	5.74
13	4.10	1.00	5.80	2.70	Iris-versicolor	5.78
14	1.30	0.30	5.00	3.50	Iris-setosa	4.58
15	5.40	2.10	6.90	3.10	Iris-virginica	6.54
16	4.50	1.70	4.90	2.50	Iris-virginica	5.58
17	5.10	1.80	5.90	3.00	Iris-virginica	6.1
18	4.80	1.80	6.00	3.00	Iris-virginica	6.1
19	1.40	0.20	4.40	2.90	Iris-setosa	4.78
20	1.50	0.10	4.90	3.10	Iris-setosa	4.9
21	1.50	0.10	4.90	3.10	Iris-setosa	4.9
22	5.10	1.60	6.00	2.70	Iris-versicolor	6.18
23	1.40	0.10	4.80	3.00	Iris-setosa	4.72
24	5.50	1.80	6.50	3.00	Iris-virginica	6.46
25	3.70	1.00	5.50	2.40	Iris-versicolor	5.46
26	5.10	1.90	5.80	2.70	Iris-virginica	6.06
27	1.50	0.20	5.40	3.70	Iris-setosa	5.04
28	1.20	0.20	5.00	3.20	Iris-setosa	4.86
29	1.30	0.20	5.50	3.50	Iris-setosa	4.68
30	5.60	2.10	6.40	2.80	Iris-virginica	6.64
31	1.30	0.20	4.40	3.20	Iris-setosa	4.68
32	5.70	2.50	6.70	3.30	Iris-virginica	6.68
33	1.20	0.20	5.80	4.00	Iris-setosa	4.86
34	4.40	1.40	6.60	3.00	Iris-versicolor	6.14
35	5.80	1.60	7.20	3.00	Iris-virginica	6.7
36	4.20	1.30	5.70	2.90	Iris-versicolor	5.66
37	1.70	0.30	5.70	3.80	Iris-setosa	5.22
38	1.70	0.40	5.40	3.90	Iris-setosa	5.26
39	4.70	1.40	7.00	3.20	Iris-versicolor	6.54
40	4.00	1.20	5.80	2.60	Iris-versicolor	5.74
41	6.10	2.50	7.20	3.60	Iris-virginica	6.94
42	5.00	2.00	5.70	2.50	Iris-virginica	5.98
43	3.90	1.10	5.60	2.50	Iris-versicolor	5.74
44	1.50	0.40	5.40	3.40	Iris-setosa	5.26
45	6.90	2.30	7.70	2.60	Iris-virginica	7.72
46	5.60	2.40	6.70	3.10	Iris-virginica	6.6
47	5.60	2.40	6.30	3.40	Iris-virginica	6.6
48	1.40	0.20	5.10	3.50	Iris-setosa	4.78
49	1.50	0.20	5.30	3.70	Iris-setosa	5.04
50	1.50	0.20	5.00	3.40	Iris-setosa	5.04
51	4.10	1.30	5.60	3.00	Iris-versicolor	5.58
52	4.30	1.30	6.40	2.90	Iris-versicolor	6.04
53	1.50	0.40	5.10	3.70	Iris-setosa	5.26
54	4.40	1.40	6.70	3.10	Iris-versicolor	6.14
55	5.10	2.00	6.50	3.20	Iris-virginica	6.06
56	5.00	1.70	6.70	3.00	Iris-versicolor	6.2
57	4.30	1.30	6.20	2.90	Iris-versicolor	6.04
58	5.00	1.90	6.30	2.50	Iris-virginica	5.84
59	4.70	1.20	6.10	2.80	Iris-versicolor	6.3
60	5.50	2.10	6.80	3.00	Iris-virginica	6.64
61	4.90	2.00	5.60	2.80	Iris-virginica	6.0
62	1.50	0.20	5.20	3.50	Iris-setosa	5.04
63	6.10	1.90	7.40	2.80	Iris-virginica	7.14
64	1.30	0.20	4.70	3.20	Iris-setosa	4.68
65	4.50	1.50	6.40	3.20	Iris-versicolor	5.92
66	6.40	2.00	7.90	3.80	Iris-virginica	7.58
67	4.40	1.30	6.30	2.30	Iris-versicolor	6.02
68	6.10	2.30	7.70	3.00	Iris-virginica	7.02
69	3.30	1.00	5.00	2.30	Iris-versicolor	5.14
70	5.10	1.50	6.30	2.80	Iris-virginica	6.3
71	4.60	1.40	6.10	3.00	Iris-versicolor	6.46
72	1.60	0.20	4.80	3.10	Iris-setosa	4.88
73	1.70	0.50	5.10	3.30	Iris-setosa	5.24
74	4.90	1.50	6.90	3.10	Iris-versicolor	6.46
75	1.40	0.30	4.60	3.40	Iris-setosa	4.68
76	5.80	1.80	6.70	2.50	Iris-virginica	6.76
77	4.50	1.30	5.70	2.80	Iris-versicolor	6.04
78	5.90	2.30	6.80	3.20	Iris-virginica	7.0
79	1.60	0.20	4.80	3.40	Iris-setosa	4.88
80	5.30	1.90	6.40	2.70	Iris-virginica	6.08
81	1.70	0.20	5.40	3.40	Iris-setosa	4.94
82	1.90	0.40	5.10	3.80	Iris-setosa	5.22
83	4.20	1.30	5.60	2.70	Iris-versicolor	5.66
84	6.00	2.50	6.30	3.30	Iris-virginica	6.94
85	5.20	2.00	6.50	3.00	Iris-virginica	6.2
86	4.70	1.50	6.70	3.10	Iris-versicolor	6.52
87	1.60	0.40	5.00	3.40	Iris-setosa	5.32
88	4.70	1.40	6.10	2.90	Iris-versicolor	6.54
89	1.40	0.20	4.60	3.20	Iris-setosa	4.78
90	5.90	2.10	7.10	3.00	Iris-virginica	6.8
91	3.50	1.00	5.70	2.60	Iris-versicolor	5.22
92	1.40	0.30	5.10	3.50	Iris-setosa	4.68
93	1.50	0.10	5.20	4.10	Iris-setosa	4.9
94	4.90	1.50	6.30	2.50	Iris-versicolor	6.46
95	4.50	1.50	6.00	2.90	Iris-versicolor	5.92
96	5.50	1.80	6.40	3.10	Iris-virginica	6.46
97	1.40	0.30	4.80	3.00	Iris-setosa	4.68
98	4.50	1.50	5.40	3.00	Iris-versicolor	5.92
99	5.00	1.50	6.00	2.20	Iris-virginica	6.3
100	1.00	0.20	4.60	3.60	Iris-setosa	4.82

Out[8]:

Rows: 1-100 of 150 | Columns: 6