Loading...

verticapy.machine_learning.vertica.neighbors.KNeighborsRegressor.predict#

KNeighborsRegressor.predict(vdf: str | vDataFrame, X: str | list[str] | None = None, name: str | None = None, inplace: bool = True) vDataFrame#

Predicts using the input relation.

Parameters#

vdf: SQLRelation

Object used to run the prediction. You can also specify a customized relation, but you must enclose it with an alias. For example, (SELECT 1) x is valid, whereas (SELECT 1) and SELECT 1 are invalid.

X: SQLColumns, optional

list of the columns used to deploy the models. If empty, the model predictors are used.

name: str, optional

Name of the added :py:class`vDataColumn`. If empty, a name is generated.

inplace: bool, optional

If set to True, the prediction is added to the :py:class`vDataFrame`.

Returns#

vDataFrame

the input object.

Examples#

We import verticapy:

import verticapy as vp

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)
13.80.310.0211.10.03620.0114.00.992483.750.4412.460white
23.90.2250.44.20.0329.0118.00.9893.570.3612.881white
34.20.170.361.80.02993.0161.00.989993.650.8912.071white
44.20.2150.235.10.04164.0157.00.996883.420.448.030white
54.40.320.394.30.0331.0127.00.989043.460.3612.881white
64.40.460.12.80.02431.0111.00.988163.480.3413.160white
74.40.540.095.10.03852.097.00.990223.410.412.271white
84.50.190.210.950.03389.0159.00.993323.340.428.050white
94.60.4450.01.40.05311.0178.00.994263.790.5510.250white
104.60.520.152.10.0548.065.00.99343.90.5613.140red
114.70.1450.291.00.04235.090.00.99083.760.4911.360white
124.70.3350.141.30.03669.0168.00.992123.470.4610.550white
134.70.4550.181.90.03633.0106.00.987463.210.8314.071white
144.70.60.172.30.05817.0106.00.99323.850.612.960red
154.70.670.091.00.025.09.00.987223.30.3413.650white
164.70.7850.03.40.03623.0134.00.989813.530.9213.860white
174.80.130.321.20.04240.098.00.98983.420.6411.871white
184.80.170.282.90.0322.0111.00.99023.380.3411.371white
194.80.210.2110.20.03717.0112.00.993243.660.4812.271white
204.80.2250.381.20.07447.0130.00.991323.310.410.360white
214.80.260.2310.60.03423.0111.00.992743.460.2811.571white
224.80.290.231.10.04438.0180.00.989243.280.3411.960white
234.80.330.06.50.02834.0163.00.99373.350.619.950white
244.80.340.06.50.02833.0163.00.99393.360.619.960white
254.80.650.121.10.0134.010.00.992463.320.3613.540white
264.90.2350.2711.750.0334.0118.00.99543.070.59.460white
274.90.330.311.20.01639.0150.00.987133.330.5914.081white
284.90.3350.141.30.03669.0168.00.992123.470.4610.466666666666750white
294.90.3350.141.30.03669.0168.00.992123.470.4610.466666666666750white
304.90.3450.341.00.06832.0143.00.991383.240.410.150white
314.90.3450.341.00.06832.0143.00.991383.240.410.150white
324.90.420.02.10.04816.042.00.991543.710.7414.071red
334.90.470.171.90.03560.0148.00.989643.270.3511.560white
345.00.170.561.50.02624.0115.00.99063.480.3910.871white
355.00.20.41.90.01520.098.00.98973.370.5512.0560white
365.00.2350.2711.750.0334.0118.00.99543.070.59.460white
375.00.240.195.00.04317.0101.00.994383.670.5710.050white
385.00.240.212.20.03931.0100.00.990983.690.6211.760white
395.00.240.341.10.03449.0158.00.987743.320.3213.171white
405.00.2550.222.70.04346.0153.00.992383.750.7611.360white
415.00.270.324.50.03258.0178.00.989563.450.3112.671white
425.00.270.324.50.03258.0178.00.989563.450.3112.671white
435.00.270.41.20.07642.0124.00.992043.320.4710.160white
445.00.290.545.70.03554.0155.00.989763.270.3412.981white
455.00.30.333.70.0354.0173.00.98873.360.313.071white
465.00.310.06.40.04643.0166.00.9943.30.639.960white
475.00.330.161.50.04910.097.00.99173.480.4410.760white
485.00.330.161.50.04910.097.00.99173.480.4410.760white
495.00.330.161.50.04910.097.00.99173.480.4410.760white
505.00.330.184.60.03240.0124.00.991143.180.411.060white
515.00.330.2311.80.0323.0158.00.993223.410.6411.860white
525.00.350.257.80.03124.0116.00.992413.390.411.360white
535.00.350.257.80.03124.0116.00.992413.390.411.360white
545.00.380.011.60.04826.060.00.990843.70.7514.060red
555.00.40.54.30.04629.080.00.99023.490.6613.660red
565.00.420.242.00.0619.050.00.99173.720.7414.081red
575.00.440.0418.60.03938.0128.00.99853.370.5710.260white
585.00.4550.181.90.03633.0106.00.987463.210.8314.071white
595.00.550.148.30.03235.0164.00.99183.530.5112.581white
605.00.610.121.30.00965.0100.00.98743.260.3713.550white
615.00.740.01.20.04116.046.00.992584.010.5912.560red
625.01.020.041.40.04541.085.00.99383.750.4810.540red
635.01.040.241.60.0532.096.00.99343.740.6211.550red
645.10.110.321.60.02812.090.00.990083.570.5212.260white
655.10.140.250.70.03915.089.00.99193.220.439.260white
665.10.1650.225.70.04742.0146.00.99343.180.559.960white
675.10.210.281.40.04748.0148.00.991683.50.4910.450white
685.10.230.181.00.05313.099.00.989563.220.3911.550white
695.10.250.361.30.03540.078.00.98913.230.6412.171white
705.10.260.331.10.02746.0113.00.989463.350.4311.471white
715.10.260.346.40.03426.099.00.994493.230.419.260white
725.10.290.288.30.02627.0107.00.993083.360.3711.060white
735.10.290.288.30.02627.0107.00.993083.360.3711.060white
745.10.30.32.30.04840.0150.00.989443.290.4612.260white
755.10.3050.131.750.03617.073.00.993.40.5112.333333333333350white
765.10.310.30.90.03728.0152.00.9923.540.5610.160white
775.10.330.221.60.02718.089.00.98933.510.3812.571white
785.10.330.221.60.02718.089.00.98933.510.3812.571white
795.10.330.221.60.02718.089.00.98933.510.3812.571white
805.10.330.276.70.02244.0129.00.992213.360.3911.071white
815.10.350.266.80.03436.0120.00.991883.380.411.560white
825.10.350.266.80.03436.0120.00.991883.380.411.560white
835.10.350.266.80.03436.0120.00.991883.380.411.560white
845.10.390.211.70.02715.072.00.98943.50.4512.560white
855.10.420.01.80.04418.088.00.991573.680.7313.671red
865.10.420.011.50.01725.0102.00.98943.380.3612.371white
875.10.470.021.30.03418.044.00.99213.90.6212.860red
885.10.510.182.10.04216.0101.00.99243.460.8712.971red
895.10.520.062.70.05230.079.00.99323.320.439.350white
905.10.5850.01.70.04414.086.00.992643.560.9412.971red
915.20.1550.331.60.02813.059.00.989753.30.8411.981white
925.20.1550.331.60.02813.059.00.989753.30.8411.981white
935.20.160.340.80.02926.077.00.991553.250.5110.160white
945.20.170.270.70.0311.068.00.992183.30.419.850white
955.20.1850.221.00.0347.0123.00.992183.550.4410.1560white
965.20.20.273.20.04716.093.00.992353.440.5310.171white
975.20.210.311.70.04817.061.00.989533.240.3712.071white
985.20.220.466.20.06641.0187.00.993623.190.429.7333333333333350white
995.20.240.157.10.04332.0134.00.993783.240.489.960white
1005.20.240.453.80.02721.0128.00.9923.550.4911.281white
Rows: 1-100 | Columns: 14

Divide your dataset into training and testing subsets.

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

Let’s import the model:

from verticapy.machine_learning.vertica import LinearRegression

Then we can create the model:

model = LinearRegression(
    tol = 1e-6,
    max_iter = 100,
    solver = 'newton',
    fit_intercept = True,
)

We can now fit the model:

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

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
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)
123
prediction
Float(22)
14.40.320.394.30.0331.0127.00.989043.460.3612.881white6.17342587232244
24.40.460.12.80.02431.0111.00.988163.480.3413.160white6.16353751019562
34.60.4450.01.40.05311.0178.00.994263.790.5510.250white5.29236978671224
44.70.7850.03.40.03623.0134.00.989813.530.9213.860white5.77047147736809
54.80.130.321.20.04240.098.00.98983.420.6411.871white6.1401329593302
64.90.2350.2711.750.0334.0118.00.99543.070.59.460white5.73647402884055
75.00.170.561.50.02624.0115.00.99063.480.3910.871white6.01474405542749
85.00.30.333.70.0354.0173.00.98873.360.313.071white6.3043169098581
95.00.330.161.50.04910.097.00.99173.480.4410.760white5.7833636294136
105.00.330.184.60.03240.0124.00.991143.180.411.060white5.99172389840106
115.00.330.2311.80.0323.0158.00.993223.410.6411.860white5.99528195215157
125.00.350.257.80.03124.0116.00.992413.390.411.360white5.92469727001426
135.00.610.121.30.00965.0100.00.98743.260.3713.550white6.18354871506406
145.01.020.041.40.04541.085.00.99383.750.4810.540red4.98918322303496
155.10.310.30.90.03728.0152.00.9923.540.5610.160white5.73081449279169
165.10.390.211.70.02715.072.00.98943.50.4512.560white6.08308012775314
175.20.1550.331.60.02813.059.00.989753.30.8411.981white6.20356844938894
185.20.170.270.70.0311.068.00.992183.30.419.850white5.81810389256722
195.20.370.331.20.02813.081.00.99023.370.3811.760white5.96533014690971
205.20.380.267.70.05320.0103.00.99253.270.4512.260white5.91198762388194
215.20.6450.02.150.0815.028.00.994443.780.6112.560red5.23643902774566
225.30.160.391.00.02840.0101.00.991563.570.5910.660white5.92725206935754
235.30.40.253.90.03145.0130.00.990723.310.5811.7571white6.00618145390209
245.30.760.032.70.04327.093.00.99323.340.389.250white5.36414298392452
255.40.2050.1612.550.05131.0115.00.995643.40.3810.860white5.84095178484785
265.40.2550.331.20.05129.0122.00.990483.370.6611.360white6.03751504706659
275.40.270.224.60.02229.0107.00.988893.330.5413.860white6.4077652470863
285.40.3750.43.30.05429.0147.00.994823.420.529.150white5.41723460223076
295.40.4150.191.60.03927.088.00.992653.540.4110.071white5.64652629808646
305.40.460.152.10.02629.0130.00.989533.390.7713.481white6.08012941970765
315.40.50.135.00.02812.0107.00.990793.480.8813.571white5.99670494064048
325.50.170.232.90.03910.0108.00.992433.280.510.050white5.92230987929241
335.50.170.232.90.03910.0108.00.992433.280.510.050white5.92230987929241
345.50.280.211.60.03223.085.00.990273.420.4212.550white6.09446714782592
355.50.30.251.90.02933.0118.00.989723.360.6612.560white6.16591521608933
365.50.320.131.30.03745.0156.00.991843.260.3810.750white5.83914646830715
375.50.3750.381.70.03617.098.00.991423.290.3910.560white5.84793205255372
385.60.150.315.30.0388.079.00.99233.30.3910.560white6.06207523277192
395.60.160.271.40.04453.0168.00.99183.280.3710.160white5.96537448215039
405.60.180.292.30.045.047.00.991263.070.4510.140white6.06284212956334
415.60.180.581.250.03429.0129.00.989843.510.612.071white6.18833862464601
425.60.1850.491.10.0328.0117.00.99183.550.4510.360white5.91174434414319
435.60.190.312.70.02711.0100.00.989643.460.413.271white6.29977236800522
445.60.190.461.10.03233.0115.00.99093.360.510.460white6.03818181654364
455.60.210.41.30.04181.0147.00.99013.220.9511.681white6.15059053465563
465.60.230.258.00.04331.0101.00.994293.190.4210.460white5.8419244506249
475.60.240.342.00.04114.073.00.989813.040.4511.671white6.20535425737336
485.60.250.192.40.04942.0166.00.9923.250.4310.460white5.92128322814776
495.60.280.46.10.03436.0118.00.991443.210.4312.171white6.1121573339739
505.60.2950.22.20.04918.0134.00.993783.210.6810.050white5.62752157973759
515.60.320.337.40.03725.095.00.992683.250.4911.160white5.96967967244706
525.60.340.11.30.03120.068.00.99063.360.5111.271white6.01765094409325
535.60.340.252.50.04647.0182.00.990933.210.411.350white6.00414945215749
545.60.350.145.00.04648.0198.00.99373.30.7110.350white5.72270177850734
555.60.350.46.30.02223.0174.00.99223.540.511.671white5.96278387801593
565.60.390.244.70.03427.077.00.99063.280.3612.750white6.10838014903018
575.60.490.134.50.03917.0116.00.99073.420.913.771white6.02389843429197
585.60.540.041.70.0495.013.00.99423.720.5811.450red5.38454090067904
595.70.1350.34.60.04219.0101.00.99463.310.429.360white5.73433851635627
605.70.140.35.40.04526.0105.00.994693.320.459.350white5.75133200039846
615.70.180.262.20.02321.095.00.98933.070.5412.360white6.35429457560235
625.70.210.242.30.04760.0189.00.9953.650.7210.160white5.5322933234431
635.70.210.251.10.03526.081.00.99023.310.5211.460white6.15920352845356
645.70.220.2216.650.04439.0110.00.998553.240.489.060white5.6289281335244
655.70.220.2216.650.04439.0110.00.998553.240.489.060white5.6289281335244
665.70.240.31.30.0325.098.00.989683.370.4312.471white6.21394562851614
675.70.2650.286.90.03646.0150.00.992993.360.4410.871white5.96528735574319
685.70.310.284.10.0322.086.00.990623.310.3811.771white6.14960203110368
695.70.40.355.10.02617.0113.00.990523.180.6712.460white6.13235605428363
705.80.170.361.30.03611.070.00.992023.430.6810.471white5.94265745560858
715.80.230.22.00.04339.0154.00.992263.210.3910.260white5.91083581328579
725.80.240.391.50.05437.0158.00.99323.210.529.360white5.72848944019364
735.80.250.2413.30.04441.0137.00.99723.340.429.550white5.66907664630173
745.80.260.181.20.03140.0114.00.99083.420.411.071white6.0643364629027
755.80.260.291.00.04235.0101.00.990443.360.4811.471white6.0940460390884
765.80.270.2212.70.05842.0206.00.99463.320.3812.360white5.99724590993438
775.80.280.181.20.0587.0108.00.992883.230.589.5540white5.75402263930962
785.80.280.344.00.03140.099.00.98963.390.3912.871white6.31934300314177
795.80.290.261.70.0633.011.00.99153.390.5413.560red5.95343884469392
805.80.30.121.60.03657.0163.00.992393.380.5910.560white5.83343273856269
815.80.30.384.90.03922.086.00.989633.230.5813.171white6.3332915619477
825.80.320.22.60.02717.0123.00.989363.360.7813.971white6.28044638317328
835.80.330.235.00.05329.0106.00.994583.130.529.050white5.63192842118016
845.80.340.167.00.03726.0116.00.99493.460.4510.071white5.67217684205428
855.80.350.293.20.03441.0151.00.99123.350.5811.633333333333371white6.01366968088107
865.80.380.261.10.05820.0140.00.992713.270.439.760white5.6917328152683
875.80.420.32.20.03526.0129.00.9893.320.4712.960white6.22960906591132
885.80.540.01.40.03340.0107.00.989183.260.3512.450white6.11497506115435
895.80.60.01.30.04472.0197.00.992023.560.4310.950white5.66502925360913
905.90.180.285.10.03950.0139.00.991653.160.4411.360white6.17000983386814
915.90.190.211.70.04557.0135.00.993413.320.449.550white5.77856668451847
925.90.190.267.40.03433.0123.00.9953.490.4210.160white5.78897330487197
935.90.20.41.30.04723.092.00.992323.20.4510.060white5.88761808495215
945.90.210.237.90.03322.0130.00.99443.380.5910.960white5.88327654970939
955.90.220.381.30.04624.090.00.992323.20.4710.060white5.87516061411651
965.90.240.2612.30.05334.0134.00.99723.340.459.560white5.64607446796111
975.90.250.1912.40.04750.0162.00.99733.350.389.550white5.63682150214692
985.90.260.2112.50.03436.0152.00.99723.280.439.560white5.64662008307633
995.90.260.31.00.03638.0114.00.99283.580.489.450white5.7748223923719
1005.90.270.279.00.05143.0136.00.99413.250.5310.760white5.92205889522828
Rows: 1-100 | Columns: 15

Important

For this example, a specific model is utilized, and it may not correspond exactly to the model you are working with. To see a comprehensive example specific to your class of interest, please refer to that particular class.