Loading...

verticapy.machine_learning.vertica.linear_model.LinearRegression.predict

LinearRegression.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    | 144.71456 | 6.78086|21.34163 | 0.00000
 fixed_acidity  |  0.13856  | 0.01240|11.17168 | 0.00000
volatile_acidity| -0.74679  | 0.08745|-8.53973 | 0.00000
  citric_acid   | -0.16321  | 0.09442|-1.72857 | 0.08394
 residual_sugar |  0.04173  | 0.00382|10.91472 | 0.00000
   chlorides    | -0.05443  | 0.37811|-0.14397 | 0.88553
    density     |-140.55688 | 6.89726|-20.37867| 0.00000


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


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_76cff358979911efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_770946ee979911efa8720242ac120002_"', '"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|5196 

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.60.172.30.05817.0106.00.99323.850.612.960red5.38169013101381
24.80.330.06.50.02834.0163.00.99373.350.619.950white5.73155518137344
35.00.270.324.50.03258.0178.00.989563.450.3112.671white6.25007059296192
45.10.350.266.80.03436.0120.00.991883.380.411.560white5.98375894463129
55.10.350.266.80.03436.0120.00.991883.380.411.560white5.98375894463129
65.10.5850.01.70.04414.086.00.992643.560.9412.971red5.53049436274353
75.20.1850.221.00.0347.0123.00.992183.550.4410.1560white5.84336651177316
85.30.580.076.90.04334.0149.00.99443.340.579.750white5.52019761631777
95.30.760.032.70.04327.093.00.99323.340.389.250white5.3856958600212
105.40.180.244.80.04130.0113.00.994453.420.49.460white5.71046762441605
115.40.290.381.20.02931.0132.00.988953.280.3612.460white6.2289511258877
125.40.50.135.00.02812.0107.00.990793.480.8813.571white6.01293951087737
135.40.530.162.70.03634.0128.00.988563.20.5313.281white6.20266150541744
145.50.160.261.50.03235.0100.00.990763.430.7712.060white6.1174229891738
155.50.240.328.70.0619.0102.00.9943.270.3110.450white5.89143167753747
165.60.20.6610.20.04378.0175.00.99452.980.4310.471white5.87291390515554
175.60.2950.22.20.04918.0134.00.993783.210.6810.050white5.64405971951845
185.60.390.244.70.03427.077.00.99063.280.3612.750white6.1187045112795
195.60.460.244.80.04224.072.00.99083.290.3712.660white6.04205549590128
205.60.50.092.30.04917.099.00.99373.630.6313.050red5.52433809736672
215.70.320.52.60.04917.0155.00.99273.220.6410.060white5.75877770068291
225.70.6950.066.80.0429.084.00.994323.440.4410.250white5.49849699323693
235.80.190.2510.80.04233.0124.00.996463.220.419.260white5.72461052512585
245.80.260.249.20.04455.0152.00.99613.310.389.450white5.65768705315762
255.80.260.249.20.04455.0152.00.99613.310.389.450white5.65768705315762
265.80.280.669.10.03926.0159.00.99653.660.5510.850white5.51408027258944
275.80.330.216.050.04726.0166.00.99763.090.468.950white5.68680792210779
285.80.360.263.30.03840.0153.00.99113.340.5511.360white6.03663391486458
295.80.360.51.00.12763.0178.00.992123.10.459.750white5.75326699952592
305.90.250.1912.40.04750.0162.00.99733.350.389.550white5.6518829367572
315.90.340.312.00.0338.0142.00.988923.40.4112.971white6.30986243021152
326.00.170.295.00.02825.0108.00.990763.140.3412.360white6.32061800975617
336.00.190.2612.40.04850.0147.00.99723.30.368.960white5.71312278801722
346.00.210.342.00.04263.0123.00.990523.440.4211.460white6.19036049812198
356.00.260.262.20.03510.072.00.9894653.110.4812.1560white6.32309254941839
366.00.270.323.60.03536.0133.00.992153.230.4610.860white5.98686225446829
376.00.280.2417.80.04742.0111.00.998963.10.458.960white5.62720472519985
386.00.280.526.20.02837.0104.00.991613.280.5111.871white6.13153871060436
396.00.320.31.90.03341.0142.00.989123.290.4212.871white6.30783805675821
406.00.340.6615.90.04626.0164.00.99793.140.58.860white5.583603366598
416.00.450.421.10.05161.0197.00.99323.020.49.050white5.58333250812416
426.00.580.22.40.07515.050.00.994673.580.6712.560red5.36848228027574
436.00.6150.040.80.0328.050.00.990363.140.411.040white5.90982686917454
446.10.210.41.40.06640.5165.00.99123.250.5911.960red6.07249916561676
456.10.240.279.80.06233.0152.00.99663.310.479.560white5.66307471761246
466.10.240.329.00.03141.0134.00.992343.250.2612.371white6.22198825069287
476.10.250.2810.00.05556.0131.00.9943.220.3510.960white6.02815012895016
486.10.260.512.20.0561.0154.00.99293.080.69.860white5.81251691653472
496.10.280.2419.950.07432.0174.00.999223.190.449.360white5.69277038517413
506.10.340.215.00.04217.0133.00.993733.020.539.450white5.80235969625866
516.10.340.215.00.04217.0133.00.993733.020.539.450white5.80235969625866
526.10.350.071.40.06922.0108.00.99343.230.529.250white5.71241840334082
536.10.410.1410.40.03718.0119.00.9963.380.4510.050white5.66807156564806
546.10.440.284.250.03243.0132.00.99163.260.4711.371white5.98488727596293
556.10.560.02.20.0796.09.00.99483.590.5411.560red5.40307863953956
566.10.7150.12.60.05313.027.00.993623.570.511.950red5.45497059310995
576.20.160.541.40.12637.0110.00.99323.230.378.960white5.81646547717526
586.20.260.377.10.04754.0201.00.995233.190.489.560white5.72637588791378
596.20.270.326.30.04847.0159.00.992823.210.611.060white6.03237011336091
606.20.30.2613.40.04657.0206.00.997753.170.439.560white5.62322195206477
616.20.330.291.30.04226.0138.00.99563.770.649.550white5.39337559680783
626.20.350.312.60.03637.092.00.989383.270.5312.871white6.30401807140467
636.20.360.383.20.03120.089.00.989563.060.3312.071white6.2851369794823
646.20.510.141.90.05615.034.00.993963.480.5711.560red5.53822487606948
656.20.560.091.70.05324.032.00.994023.540.611.350red5.49242910374238
666.20.630.311.70.08815.064.00.99693.460.799.350red4.99753903089078
676.20.760.013.20.04118.0120.00.990263.20.9413.771white5.94787303618645
686.30.10.246.00.03925.0107.00.995113.590.4910.571white5.85233183904353
696.30.230.336.90.05223.0118.00.99383.230.4610.460white5.96154126109826
706.30.250.2314.90.03947.0142.00.997053.140.359.760white5.84068276696576
716.30.250.2314.90.03947.0142.00.997053.140.359.760white5.84068276696576
726.30.270.255.80.03852.0155.00.9953.280.389.460white5.73091445389474
736.30.270.255.80.03852.0155.00.9953.280.389.460white5.73091445389474
746.30.290.46.50.03943.0167.00.99533.150.449.360white5.67848865031129
756.30.320.2612.30.04424.0205.00.996113.110.589.950white5.80685833254873
766.30.340.296.20.04629.0227.00.99523.290.5310.160white5.6602568440033
776.30.390.246.90.0699.0117.00.99423.150.3510.240white5.79959517148285
786.30.410.183.50.02723.0109.00.990183.340.5412.881white6.21988672546405
796.31.020.02.00.08317.024.00.994373.590.5511.240red5.13914113965495
806.40.150.291.80.04421.0115.00.991663.10.3810.250white6.13006073106666
816.40.180.329.60.05224.090.00.99633.350.499.460white5.77565368732891
826.40.290.243.20.03731.095.00.989422.90.6612.671white6.40732405550557
836.40.290.443.60.275.0181.00.99423.020.419.150white5.71064073602463
846.40.30.362.00.05218.0141.00.992733.380.5310.560white5.86413263285232
856.40.310.538.80.05736.0221.00.996423.170.449.150white5.5937723605669
866.40.40.254.20.03215.091.00.989883.260.5213.160white6.30089328900794
876.40.420.468.40.0558.0180.00.994953.180.469.760white5.71335655078278
886.40.560.151.80.07817.065.00.992943.330.610.560red5.66496172773219
896.50.080.331.90.02823.093.00.9913.340.712.071white6.28747520003412
906.50.170.331.40.02814.099.00.99283.230.5510.160white5.94639542006701
916.50.20.353.90.0427.0140.00.991022.980.5311.860white6.27459642827426
926.50.210.5117.60.04534.0125.00.999663.20.478.860white5.59806488471614
936.50.220.283.70.05929.0151.00.991773.230.4112.171white6.15628673311403
946.50.260.2812.50.04680.0225.00.996853.180.4110.060white5.78033845376572
956.50.270.196.60.04598.0175.00.993643.160.3410.160white5.99258037288686
966.50.280.268.80.0444.0139.00.99563.320.3710.260white5.79027979385705
976.50.330.388.30.04868.0174.00.994923.140.59.650white5.80763235289842
986.50.360.283.20.03729.0119.00.99083.250.6512.481white6.16840750710136
996.50.360.3113.550.05320.0113.00.995443.20.5611.060white5.94238621482944
1006.50.360.366.70.18551.5151.00.995283.170.429.350white5.66366295263498
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.