Loading...

verticapy.machine_learning.vertica.neighbors.KNeighborsRegressor.predict

KNeighborsRegressor.predict(vdf: Annotated[str | vDataFrame, ''], X: Annotated[str | list[str], 'STRING representing one column or a list of columns'] | 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.90.2250.44.20.0329.0118.00.9893.570.3612.881white
24.70.3350.141.30.03669.0168.00.992123.470.4610.550white
34.70.4550.181.90.03633.0106.00.987463.210.8314.071white
44.70.7850.03.40.03623.0134.00.989813.530.9213.860white
54.90.3450.341.00.06832.0143.00.991383.240.410.150white
64.90.3450.341.00.06832.0143.00.991383.240.410.150white
74.90.420.02.10.04816.042.00.991543.710.7414.071red
85.00.270.41.20.07642.0124.00.992043.320.4710.160white
95.00.310.06.40.04643.0166.00.9943.30.639.960white
105.00.40.54.30.04629.080.00.99023.490.6613.660red
115.00.440.0418.60.03938.0128.00.99853.370.5710.260white
125.10.110.321.60.02812.090.00.990083.570.5212.260white
135.10.140.250.70.03915.089.00.99193.220.439.260white
145.10.1650.225.70.04742.0146.00.99343.180.559.960white
155.10.330.221.60.02718.089.00.98933.510.3812.571white
165.10.330.221.60.02718.089.00.98933.510.3812.571white
175.10.330.221.60.02718.089.00.98933.510.3812.571white
185.10.390.211.70.02715.072.00.98943.50.4512.560white
195.20.20.273.20.04716.093.00.992353.440.5310.171white
205.20.210.311.70.04817.061.00.989533.240.3712.071white
215.20.220.466.20.06641.0187.00.993623.190.429.7333333333333350white
225.20.310.22.40.02727.0117.00.988863.560.4513.071white
235.20.320.251.80.10313.050.00.99573.380.559.250red
245.20.340.376.20.03142.0133.00.990763.250.4112.560white
255.20.360.021.60.03124.0104.00.98963.440.3512.260white
265.20.3650.0813.50.04137.0142.00.9973.460.399.960white
275.20.480.041.60.05419.0106.00.99273.540.6212.271red
285.20.50.182.00.03623.0129.00.989493.360.7713.471white
295.30.160.391.00.02840.0101.00.991563.570.5910.660white
305.30.160.391.00.02840.0101.00.991563.570.5910.660white
315.30.1650.241.10.05125.0105.00.99253.320.479.150white
325.30.230.560.90.04146.0141.00.991193.160.629.750white
335.30.30.31.20.02925.093.00.987423.310.413.671white
345.30.330.31.20.04825.0119.00.990453.320.6211.360white
355.30.360.276.30.02840.0132.00.991863.370.411.660white
365.30.360.276.30.02840.0132.00.991863.370.411.660white
375.30.40.253.90.03145.0130.00.990723.310.5811.7571white
385.30.470.112.20.04816.089.00.991823.540.8813.671red
395.30.470.112.20.04816.089.00.991823.540.8813.566666666666771red
405.30.7150.191.50.1617.062.00.993953.620.6111.050red
415.40.220.291.20.04569.0152.00.991783.760.6311.071white
425.40.5950.12.80.04226.080.00.99323.360.389.350white
435.40.740.091.70.08916.026.00.994023.670.5611.660red
445.50.120.331.00.03823.0131.00.991643.250.459.850white
455.50.120.331.00.03823.0131.00.991643.250.459.850white
465.50.140.274.60.02922.0104.00.99493.340.449.050white
475.50.140.274.60.02922.0104.00.99493.340.449.050white
485.50.160.311.20.02631.068.00.98983.330.4411.6560white
495.50.160.311.20.02631.068.00.98983.330.4411.633333333333360white
505.50.180.225.50.03710.086.00.991563.460.4412.250white
515.50.240.451.70.04622.0113.00.992243.220.4810.050white
525.50.290.31.10.02220.0110.00.988693.340.3812.871white
535.50.310.293.00.02716.0102.00.990673.230.5611.260white
545.50.320.454.90.02825.0191.00.99223.510.4911.571white
555.50.350.351.10.04514.0167.00.9923.340.689.960white
565.50.3750.381.70.03617.098.00.991423.290.3910.560white
575.60.150.265.550.05151.0139.00.993363.470.511.060white
585.60.150.315.30.0388.079.00.99233.30.3910.560white
595.60.160.271.40.04453.0168.00.99183.280.3710.160white
605.60.1750.290.80.04320.067.00.991123.280.489.960white
615.60.1850.197.10.04836.0110.00.994383.260.419.560white
625.60.1850.197.10.04836.0110.00.994383.260.419.560white
635.60.220.321.20.02429.097.00.988233.20.4613.0571white
645.60.260.181.40.03418.0135.00.991743.320.3510.260white
655.60.260.265.70.03112.080.00.99233.250.3810.850white
665.60.260.511.40.02925.093.00.994283.230.4910.560white
675.60.280.284.20.04452.0158.00.9923.350.4410.771white
685.60.30.16.40.04334.0142.00.993823.140.489.850white
695.60.350.145.00.04648.0198.00.99373.30.7110.350white
705.60.490.134.50.03917.0116.00.99073.420.913.771white
715.60.490.134.50.03917.0116.00.99073.420.913.771white
725.60.660.02.20.0873.011.00.993783.710.6312.871red
735.60.660.02.20.0873.011.00.993783.710.6312.871red
745.70.150.4711.40.03549.0128.00.994563.030.3410.581white
755.70.180.262.20.02321.095.00.98933.070.5412.360white
765.70.180.361.20.0469.071.00.991993.70.6810.971white
775.70.20.32.50.04638.0125.00.992763.340.59.960white
785.70.210.320.90.03838.0121.00.990743.240.4610.660white
795.70.210.374.50.0458.0140.00.993323.290.6210.660white
805.70.220.216.00.04441.0113.00.998623.220.468.960white
815.70.220.216.00.04441.0113.00.998623.220.468.960white
825.70.220.216.00.04441.0113.00.998623.220.468.960white
835.70.220.216.00.04441.0113.00.998623.220.468.960white
845.70.220.216.00.04441.0113.00.998623.220.468.960white
855.70.220.293.50.0427.0146.00.989993.170.3612.160white
865.70.230.289.650.02526.0121.00.99253.280.3811.360white
875.70.250.2612.50.04952.5106.00.996913.080.459.460white
885.70.250.2612.50.04952.5120.00.996913.080.459.460white
895.70.250.2711.50.0424.0120.00.994113.330.3110.860white
905.70.260.2417.80.05923.0124.00.997733.30.510.150white
915.70.260.2417.80.05923.0124.00.997733.30.510.150white
925.70.260.2417.80.05923.0124.00.997733.30.510.150white
935.70.270.321.20.04620.0155.00.99343.80.4110.260white
945.70.280.2417.50.04460.0167.00.99893.310.449.450white
955.70.320.181.40.02926.0104.00.99063.440.3711.060white
965.70.320.384.750.03323.094.00.9913.420.4211.871white
975.70.360.344.20.02621.077.00.99073.410.4511.960white
985.80.140.156.10.04227.0123.00.993623.060.69.960white
995.80.150.321.20.03714.0119.00.991373.190.510.260white
1005.80.170.341.80.04596.0170.00.990353.380.911.881white
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,
)



=======
details
=======
   predictor    |coefficient|std_err | t_value |p_value 
----------------+-----------+--------+---------+--------
   Intercept    | 155.79271 | 6.87974|22.64515 | 0.00000
 fixed_acidity  |  0.15867  | 0.01252|12.67099 | 0.00000
volatile_acidity| -0.74549  | 0.08758|-8.51175 | 0.00000
  citric_acid   | -0.17758  | 0.09483|-1.87263 | 0.06118
 residual_sugar |  0.04836  | 0.00387|12.49523 | 0.00000
   chlorides    |  0.03330  | 0.37699| 0.08833 | 0.92962
    density     |-151.87356 | 6.99805|-21.70225| 0.00000


==============
regularization
==============
type| lambda 
----+--------
none| 1.00000


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_d796e010979a11efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_d7d03bee979a11efa8720242ac120002_"', '"quality"', '"fixed_acidity", "volatile_acidity", "citric_acid", "residual_sugar", "chlorides", "density"'
USING PARAMETERS optimizer='newton', epsilon=1e-06, max_iterations=100, regularization='none', lambda=1, alpha=0.5, fit_intercept=true)

===============
Additional Info
===============
       Name       |Value
------------------+-----
 iteration_count  |  1  
rejected_row_count|  0  
accepted_row_count|5198 

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)
15.00.330.184.60.03240.0124.00.991143.180.411.060white6.00364012009078
25.00.610.121.30.00965.0100.00.98743.260.3713.550white6.21321570123672
35.10.250.361.30.03540.078.00.98913.230.6412.171white6.19751991605423
45.20.240.453.80.02721.0128.00.9923.550.4911.281white5.88505698659006
55.20.60.077.00.04433.0147.00.99443.330.589.750white5.47497924579079
65.30.3950.071.30.03526.0102.00.9923.50.3510.660white5.73222282864558
75.50.240.328.70.0619.0102.00.9943.270.3110.450white5.89005314313548
85.60.180.311.50.03816.084.00.99243.340.5810.160white5.8465069726559
95.60.190.261.40.0312.076.00.99053.250.3710.971white6.13138851407476
105.60.190.461.10.03233.0115.00.99093.360.510.460white6.02068234053655
115.60.310.371.40.07412.096.00.99543.320.589.250red5.27968121678251
125.60.6050.052.40.07319.025.00.992583.560.5512.950red5.59319665059536
135.70.1350.34.60.04219.0101.00.99463.310.429.360white5.71362031251269
145.70.220.2216.650.04439.0110.00.998553.240.489.060white5.64734966231921
155.70.220.2216.650.04439.0110.00.998553.240.489.060white5.64734966231921
165.70.2550.651.20.07917.0137.00.993073.20.429.450white5.63118816415809
175.70.450.421.10.05161.0197.00.99323.020.49.050white5.50114943468537
185.80.210.321.60.04538.095.00.989463.230.9412.481white6.30567788271665
195.80.220.251.50.02421.0109.00.992343.370.5810.460white5.86772247202506
205.80.270.2712.30.04555.0170.00.99723.280.429.360white5.61176528814997
215.80.280.669.10.03926.0159.00.99653.660.5510.850white5.48641834113732
225.80.30.121.60.03657.0163.00.992393.380.5910.560white5.82881053950172
235.80.320.312.70.04925.0153.00.990673.440.7312.271white6.095010971221
245.80.330.216.050.04726.0166.00.99763.090.468.950white5.70012921096401
255.90.20.231.50.03738.093.00.990213.360.4912.060white6.22597439719303
265.90.230.288.60.04637.0142.00.994323.230.5310.660white5.91417763834289
275.90.320.284.70.03934.094.00.989643.220.5713.171white6.36901969691772
286.00.160.221.60.04236.0106.00.99053.240.3211.460white6.23439573454121
296.00.170.295.00.02825.0108.00.990763.140.3412.360white6.33897691843868
306.00.190.2612.40.04850.0147.00.99723.30.368.960white5.70984986018374
316.00.240.411.30.03642.0118.00.990183.040.6411.733333333333360white6.1749089543348
326.00.240.411.30.03642.0118.00.990183.040.6411.7560white6.1749089543348
336.00.280.2417.80.04742.0111.00.998963.10.458.960white5.6401143069798
346.00.420.4112.40.03250.0179.00.996223.140.69.750white5.66005436943959
356.00.6150.040.80.0328.050.00.990363.140.411.040white5.90940559798847
366.10.170.4215.10.03328.0124.00.996842.870.479.550white5.89695776133809
376.10.240.261.70.03361.0134.00.99033.190.8111.971white6.21843155362677
386.10.250.1810.50.04941.0124.00.99633.140.3510.550white5.74003176285768
396.10.310.262.20.05128.0167.00.99263.370.4710.460white5.84171708421837
406.10.340.292.20.03625.0100.00.989383.060.4411.860white6.30255847766281
416.10.340.464.70.02921.094.00.9913.290.6212.360white6.14699882439282
426.10.350.071.40.06922.0108.00.99343.230.529.250white5.68605106371959
436.10.40.161.80.06911.025.00.99553.420.7410.171red5.33320368677698
446.10.440.284.250.03243.0132.00.99163.260.4711.371white5.99162858597833
456.10.480.091.70.07818.030.00.994023.450.5411.260red5.50623192820532
466.10.560.02.20.0796.09.00.99483.590.5411.560red5.36832636513631
476.10.680.521.40.03732.0123.00.990223.240.4512.060white5.84202233813045
486.20.160.331.10.05721.082.00.9913.320.4610.971white6.14697947749346
496.20.160.541.40.12637.0110.00.99323.230.378.960white5.79237151205413
506.20.20.2515.00.0558.0120.00.997673.190.539.660white5.7904902129838
516.20.20.335.40.02821.075.00.990123.360.4113.571white6.45778581680941
526.20.230.381.60.04412.0113.00.991763.30.7311.450white5.99423904929782
536.20.240.2812.20.04954.0133.00.99523.190.3710.760white5.99486666047528
546.20.270.491.40.0520.074.00.99313.320.449.860white5.73190340468716
556.20.30.211.10.03231.0111.00.98892.970.4212.260white6.38202270488486
566.20.30.333.50.03737.0155.00.989873.180.3712.460white6.32962352028596
576.20.330.144.80.05227.0128.00.994753.210.489.450white5.66322179971408
586.20.360.225.250.03844.0145.00.991843.220.411.260white6.08989821681851
596.20.360.383.20.03120.089.00.989563.060.3312.071white6.30838874196783
606.20.460.292.10.07432.098.00.995783.330.629.850red5.25340582782772
616.20.510.141.90.05615.034.00.993963.480.5711.560red5.50890698179577
626.20.560.091.70.05324.032.00.994023.540.611.350red5.4616274921782
636.20.630.311.70.08815.064.00.99693.460.799.350red4.93414578552776
646.20.760.013.20.04118.0120.00.990263.20.9413.771white5.96991956240299
656.30.150.3411.40.0525.096.00.997543.210.4910.060white5.67313493258476
666.30.160.41.60.03359.0148.00.99143.440.5311.450white6.11304676514146
676.30.20.241.70.05236.0135.00.993743.80.6610.860white5.76172431582768
686.30.230.31.80.03316.091.00.99063.280.411.860white6.20979114468321
696.30.230.311.50.02211.082.00.98923.30.412.971white6.40576440181439
706.30.230.497.10.0567.0210.00.99513.230.349.550white5.74948788736697
716.30.260.247.20.03938.0172.00.99583.490.649.760white5.66967600416714
726.30.270.187.70.04845.0186.00.99623.230.479.050white5.63660552364192
736.30.270.187.70.04845.0186.00.99623.230.479.050white5.63660552364192
746.30.270.255.80.03852.0155.00.9953.280.389.460white5.71420859193591
756.30.270.255.80.03852.0155.00.9953.280.389.460white5.71420859193591
766.30.280.36.60.20860.0154.00.994783.10.49.460white5.77563508169675
776.30.30.23.70.03934.0132.00.991583.00.3810.750white6.11861033168822
786.30.330.217.90.06636.0161.00.99913.140.518.850white5.64175047382068
796.30.410.33.20.0349.0164.00.99273.530.7911.771white5.82427142950581
806.40.120.31.10.03137.094.00.989863.010.5611.760white6.38613041210147
816.40.180.329.60.05224.090.00.99633.350.499.460white5.77153291819346
826.40.220.327.90.02934.0124.00.99483.40.3910.250white5.88654793047891
836.40.290.443.60.275.0181.00.99423.020.419.150white5.7019301332281
846.40.290.571.00.0615.0120.00.99243.060.419.550white5.82182241568421
856.40.310.281.50.03712.0119.00.99193.320.5110.471white5.95776072718527
866.40.330.315.50.04842.0173.00.99513.190.669.360white5.6453297019701
876.40.350.355.60.0349.0148.00.994413.170.59.840white5.73247925075927
886.40.370.374.850.04139.5216.50.994323.10.59.860white5.69165057262063
896.40.410.016.10.04820.070.00.993623.190.4210.050white5.89275246267732
906.40.420.468.40.0558.0180.00.994953.180.469.760white5.71468721994029
916.40.450.071.10.0310.0131.00.99052.970.2810.850white6.08373042532577
926.40.560.151.80.07817.065.00.992943.330.610.560red5.65239866661142
936.50.080.331.90.02823.093.00.9913.340.712.071white6.29194082979834
946.50.150.555.90.04575.0162.00.994822.970.49.350white5.81453372682185
956.50.190.274.90.03713.0101.00.99163.170.4111.860white6.27484392056292
966.50.210.355.70.04347.0197.00.993923.240.510.160white5.9322680715037
976.50.220.283.70.05929.0151.00.991773.230.4112.171white6.1675870845086
986.50.220.297.40.02816.087.00.993113.150.5610.971white6.14019593603928
996.50.230.3616.30.03843.0133.00.999243.260.418.850white5.62005187374959
1006.50.280.343.60.0429.0121.00.991113.280.4812.171white6.20697111896777
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.