Loading...

verticapy.machine_learning.vertica.ensemble.XGBRegressor.predict

XGBRegressor.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    | 148.42552 | 6.73724|22.03062 | 0.00000
 fixed_acidity  |  0.13441  | 0.01236|10.87627 | 0.00000
volatile_acidity| -0.68741  | 0.08710|-7.89238 | 0.00000
  citric_acid   | -0.10147  | 0.09543|-1.06327 | 0.28771
 residual_sugar |  0.04281  | 0.00381|11.23134 | 0.00000
   chlorides    | -0.12376  | 0.39072|-0.31675 | 0.75145
    density     |-144.30539 | 6.85321|-21.05663| 0.00000


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


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_ec666b66979811efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_ecaa485e979811efa8720242ac120002_"', '"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|5197 

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.70.3350.141.30.03669.0168.00.992123.470.4610.550white5.69568988220047
24.90.3450.341.00.06832.0143.00.991383.240.410.150white5.78538530749046
34.90.420.02.10.04816.042.00.991543.710.7414.071red5.79481020254627
45.00.440.0418.60.03938.0128.00.99853.370.5710.260white5.49361403991517
55.10.330.221.60.02718.089.00.98933.510.3812.571white6.16567231736551
65.20.310.22.40.02727.0117.00.988863.560.4513.071white6.29263610674406
75.20.50.182.00.03623.0129.00.989493.360.7713.471white6.05490516646978
85.30.330.31.20.04825.0119.00.990453.320.6211.360white5.9987611258054
95.30.40.253.90.03145.0130.00.990723.310.5811.7571white6.03445335474936
105.30.470.112.20.04816.089.00.991823.540.8813.671red5.7669174931498
115.50.3750.381.70.03617.098.00.991423.290.3910.560white5.86950740811469
125.60.260.511.40.02925.093.00.994283.230.4910.560white5.95326781766136
135.60.350.145.00.04648.0198.00.99373.30.7110.350white5.7355170353205
145.70.180.262.20.02321.095.00.98933.070.5412.360white6.37155462069256
155.70.270.321.20.04620.0155.00.99343.80.4110.260white5.66628709129407
165.80.260.291.00.04235.0101.00.990443.360.4811.471white6.10872263681338
175.80.320.384.750.03323.094.00.9913.420.4211.871white6.13919864666474
185.80.610.018.40.04131.0104.00.99093.260.7214.0571white6.14710194893038
195.90.220.186.40.04128.0120.00.994033.270.59.950white5.87408185112776
205.90.340.33.80.03557.0135.00.990163.090.3412.060white6.22730520103644
215.90.4150.020.80.03822.063.00.99323.360.369.350white5.63666079751755
225.90.620.283.50.03955.0152.00.99073.440.4412.060white5.94559459008451
236.00.20.266.80.04922.093.00.99283.150.4211.060white6.08678443208936
246.00.210.2412.10.0555.0164.00.9973.340.399.450white5.70264447821137
256.00.250.45.70.05256.0152.00.993983.160.8810.560white5.82046145937301
266.00.260.241.30.05366.0150.00.99243.210.6210.460white5.86932220139019
276.00.280.2715.50.03631.0134.00.994083.190.4413.071white6.22015142600458
286.00.280.2715.50.03631.0134.00.994083.190.4413.071white6.22015142600458
296.00.30.332.10.04231.0127.00.989643.320.4212.560white6.26658829691618
306.00.360.166.30.03636.0191.00.99423.170.629.850white5.7651197501539
316.00.370.321.00.05331.0218.50.99243.290.729.860white5.77274496906128
326.00.390.1712.00.04665.0246.00.99763.150.389.060white5.49564325704128
336.00.40.31.60.04730.0117.00.99313.170.4810.160white5.67956878184535
346.00.5550.264.50.05317.0126.00.99433.240.469.150white5.5273282877402
356.00.590.00.80.03730.095.00.990323.10.410.940white5.94755695275882
366.10.140.251.30.04737.0173.00.99253.350.4610.060white5.95055022035271
376.10.150.41.20.0319.084.00.989263.190.9613.060white6.39382758990175
386.10.220.491.50.05118.087.00.99283.30.469.650white5.8359802473031
396.10.260.252.90.047289.0440.00.993143.440.6410.530white5.84420653429444
406.10.270.316.70.03949.0172.00.999853.40.459.450white5.45578515378367
416.10.360.4119.350.0767.0207.01.001183.390.539.150white5.30044901926709
426.150.210.373.20.02120.080.00.990763.390.4712.050white6.23262993114707
436.20.160.471.40.02923.081.00.993.260.4212.260white6.29519196033061
446.20.2550.241.70.039138.5272.00.994523.530.539.640white5.61257179231637
456.20.2550.271.30.03730.086.00.988343.050.5912.971white6.48445717147851
466.20.280.2710.30.0326.0108.00.993883.20.3610.760white6.05400715158555
476.20.30.4911.20.05868.0215.00.996563.190.69.460white5.66626378625963
486.20.340.311.10.04728.0237.00.99813.180.498.750white5.43289625226785
496.20.520.084.40.07111.032.00.996463.560.6311.660red5.27832571579847
506.30.210.2911.70.04849.0147.00.994823.220.3810.850white6.03560179956921
516.30.220.274.50.03681.0157.00.99283.050.7610.771white6.01548234022451
526.30.220.341.20.03632.096.00.989613.060.7411.660white6.32742930049614
536.30.220.434.550.03831.0130.00.99183.350.3311.571white6.14544565385901
546.30.230.331.50.03615.0105.00.9913.320.4211.260white6.13382939002355
556.30.260.427.10.04562.0209.00.995443.20.539.560white5.70200008496781
566.30.30.341.60.04914.0132.00.9943.30.499.560white5.65445196598941
576.30.30.918.20.03450.0199.00.993943.390.4911.760white5.88969732764994
586.30.360.282.50.03518.073.00.988683.10.4712.871white6.42726473816191
596.30.370.286.30.03445.0152.00.99213.290.4611.671white6.08968095474694
606.30.370.516.30.04835.0146.00.99433.11.0110.560white5.74713830519391
616.30.480.481.80.03535.096.00.991213.490.7412.260white5.92941891299589
626.40.120.496.40.04249.0161.00.99453.340.4410.460white5.91062510748469
636.40.140.287.90.05721.082.00.994253.260.3610.060white6.01662567427908
646.40.160.371.50.03727.0109.00.993453.380.59.860white5.83765858838433
656.40.180.7411.90.04654.0168.00.99783.580.6810.150white5.60278373965841
666.40.210.35.60.04443.0160.00.99493.60.4110.660white5.77581672699367
676.40.210.511.60.04245.0153.00.99723.150.438.850white5.68074840293247
686.40.220.341.40.02356.0115.00.989583.180.711.760white6.35537099675685
696.40.250.35.50.03815.0129.00.99483.140.499.660white5.7592119030667
706.40.310.46.40.03939.0191.00.995133.140.529.850white5.69860756876022
716.40.320.2316.20.05536.0176.00.99863.260.549.150white5.62583515070654
726.40.320.274.90.03418.0122.00.99163.360.7112.560white6.15072124150629
736.40.380.194.50.03836.0119.00.991513.070.4211.260white6.11296106830488
746.40.440.262.00.05420.0180.00.99523.580.5710.050white5.42311264454577
756.50.130.272.60.03532.076.00.99143.210.7611.333333333333360white6.22503737400271
766.50.180.261.40.04140.0141.00.99413.340.729.560white5.74993811146149
776.50.220.458.00.05352.0196.00.99593.230.489.160white5.72449604010419
786.50.220.726.80.04233.0168.00.99583.120.369.260white5.66151485340663
796.50.230.2517.30.04615.0110.00.998283.150.429.260white5.79350035754911
806.50.230.452.10.02743.0104.00.990543.020.5211.360white6.24171729214927
816.50.240.298.20.04332.0156.00.994533.130.710.160white5.93448165811805
826.50.250.2715.20.04975.0217.00.99723.190.399.950white5.84329300056956
836.50.260.341.40.0425.0184.00.992163.290.4610.750white5.96690356732523
846.50.260.341.40.0425.0184.00.992163.290.4610.750white5.96690356732523
856.50.280.254.80.02954.0128.00.990743.170.4412.271white6.31412829059752
866.50.280.275.20.0444.0179.00.99483.190.699.460white5.74198300348593
876.50.280.292.70.03826.0107.00.99123.320.4111.671white6.15266695294244
886.50.280.387.80.03154.0216.00.991543.030.4213.160white6.31368563220238
896.50.290.311.70.03524.079.00.990533.270.6911.471white6.19800586264176
906.50.290.4210.60.04266.0202.00.996743.240.539.560white5.67088088984437
916.50.330.721.10.0617.0151.00.9933.090.579.540white5.74356636812544
926.50.410.224.80.05249.0142.00.99463.140.629.250white5.6679432336897
936.60.0850.331.40.03617.0109.00.993063.270.619.560white5.9722769482353
946.60.150.341.00.03745.079.00.989492.960.511.760white6.42450143626905
956.60.220.2317.30.04737.0118.00.999063.080.468.860white5.70316291386945
966.60.230.314.90.05133.0118.00.998353.040.549.060white5.68839540432404
976.60.240.2715.80.03546.0188.00.99823.240.519.250white5.74672341739716
986.60.250.3112.40.05952.0181.00.99843.510.479.860white5.55839348237359
996.60.250.368.10.04554.0180.00.99583.080.429.250white5.74614886064668
1006.60.250.4211.30.04977.0231.00.99663.240.529.560white5.76112428540449
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.