Loading...

verticapy.machine_learning.vertica.linear_model.PLSRegression.predict

PLSRegression.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.92367 | 6.81864|21.25406 | 0.00000
 fixed_acidity  |  0.14594  | 0.01235|11.81270 | 0.00000
volatile_acidity| -0.71855  | 0.08834|-8.13440 | 0.00000
  citric_acid   | -0.19111  | 0.09494|-2.01289 | 0.04418
 residual_sugar |  0.04396  | 0.00386|11.38255 | 0.00000
   chlorides    | -0.13733  | 0.39412|-0.34844 | 0.72753
    density     |-140.82881 | 6.93599|-20.30408| 0.00000


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


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_d7d49ef6979911efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_d81d5ad8979911efa8720242ac120002_"', '"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.3350.141.30.03669.0168.00.992123.470.4610.550white5.67524848953647
24.90.3450.341.00.06832.0143.00.991383.240.410.150white5.74566002008632
35.10.110.321.60.02812.090.00.990083.570.5212.260white6.16247648637938
45.10.330.221.60.02718.089.00.98933.510.3812.571white6.13348941306012
55.10.330.221.60.02718.089.00.98933.510.3812.571white6.13348941306012
65.20.310.22.40.02727.0117.00.988863.560.4513.071white6.26340874895527
75.20.480.041.60.05419.0106.00.99273.540.6212.271red5.59217434767359
85.30.7150.191.50.1617.062.00.993953.620.6111.050red5.21411569945678
95.40.220.291.20.04569.0152.00.991783.760.6311.071white5.87362363442787
105.50.120.331.00.03823.0131.00.991643.250.459.850white5.96431411242185
115.50.310.293.00.02716.0102.00.990673.230.5611.260white6.06146625059353
125.60.160.271.40.04453.0168.00.99183.280.3710.160white5.95585967444106
135.60.1850.197.10.04836.0110.00.994383.260.419.560white5.83986457435137
145.60.220.321.20.02429.097.00.988233.20.4613.0571white6.39990447435122
155.60.260.181.40.03418.0135.00.991743.320.3510.260white5.9110271835236
165.60.260.511.40.02925.093.00.994283.230.4910.560white5.93244568019492
175.60.280.284.20.04452.0158.00.9923.350.4410.771white5.96264216324252
185.60.660.02.20.0873.011.00.993783.710.6312.871red5.39860366525167
195.70.180.361.20.0469.071.00.991993.70.6810.971white5.90305872241507
205.70.20.32.50.04638.0125.00.992763.340.59.960white5.84886305546522
215.70.210.374.50.0458.0140.00.993323.290.6210.660white5.838178094249
225.70.220.216.00.04441.0113.00.998623.220.468.960white5.62207035229341
235.70.220.293.50.0427.0146.00.989993.170.3612.160white6.27128205570455
245.70.270.321.20.04620.0155.00.99343.80.4110.260white5.64746465122369
255.70.280.2417.50.04460.0167.00.99893.310.449.450white5.59781948295637
265.70.320.384.750.03323.094.00.9913.420.4211.871white6.09589998437684
275.80.150.321.20.03714.0119.00.991373.190.510.260white6.0354035516315
285.80.260.181.20.03140.0114.00.99083.420.411.071white6.06421440369985
295.80.280.181.20.0587.0108.00.992883.230.589.5540white5.75321156839851
305.80.280.31.50.02631.0114.00.989523.320.612.571white6.22104539578206
315.80.30.333.50.03325.0116.00.990573.20.4411.760white6.14002792489532
325.80.320.284.30.03246.0115.00.989463.160.5713.081white6.32683702750606
335.80.680.021.80.08721.094.00.99443.540.5210.050red5.30470084201119
345.90.190.370.80.0273.021.00.98973.090.3110.850white6.23067358419399
355.90.220.4522.60.1255.0122.00.996363.10.3512.850white6.20144794057907
365.90.260.242.40.04627.0132.00.992343.630.7311.350white5.90115660091274
375.90.290.283.20.03516.0117.00.989593.260.4212.660white6.2959127762648
385.90.310.37.70.04760.0206.00.9953.20.399.660white5.71200423570096
395.90.540.00.80.03212.082.00.992863.250.368.850white5.60418474607241
406.00.170.299.70.04433.098.00.995363.120.369.260white5.86673895322173
416.00.20.266.80.04922.093.00.99283.150.4211.060white6.08326899169842
426.00.20.266.80.04922.093.00.99283.150.4211.060white6.08326899169842
436.00.210.380.80.0222.098.00.989413.260.3211.860white6.27078705293576
446.00.270.191.70.0224.0110.00.98983.320.4712.671white6.24862478819259
456.00.280.2715.50.03631.0134.00.994083.190.4413.071white6.22784320478624
466.00.30.332.10.04231.0127.00.989643.320.4212.560white6.23740785955519
476.00.360.166.30.03636.0191.00.99423.170.629.850white5.7700566778214
486.10.220.41.850.03125.0111.00.989663.030.311.871white6.2838126969921
496.10.30.322.20.04241.0142.00.989523.310.4412.771white6.27520834161859
506.10.450.270.80.03913.082.00.99273.230.329.550white5.66801421658747
516.10.590.012.10.0565.013.00.994723.520.5611.450red5.3874435071065
526.150.210.373.20.02120.080.00.990763.390.4712.050white6.20983507910788
536.20.150.271.40.04151.0117.00.99093.280.3811.260white6.17776713770525
546.20.170.31.10.03714.079.00.9933.50.5410.360white5.84928380871415
556.20.280.284.30.02622.0105.00.9892.980.6413.181white6.47956041213641
566.20.290.2312.40.04833.0201.00.996123.110.569.960white5.83227778659361
576.20.30.321.30.05427.0183.00.992663.30.4310.150white5.80638866488906
586.20.320.322.20.03615.070.00.98993.160.4812.760white6.22274028360283
596.20.340.287.50.03440.0197.00.994853.140.69.750white5.75216955835884
606.20.340.311.10.04728.0237.00.99813.180.498.750white5.44712168819794
616.20.450.21.60.0693.015.00.99583.410.569.250red5.29046418053537
626.20.570.12.10.0484.011.00.994483.440.7610.860red5.43410621904087
636.20.660.481.20.02929.075.00.98923.330.3912.881white6.00343656289039
646.30.220.434.550.03831.0130.00.99183.350.3311.571white6.12362236942889
656.30.230.215.10.03529.0142.00.99423.360.3310.171white5.8450814589936
666.30.260.427.10.04562.0209.00.995443.20.539.560white5.69530918739892
676.30.30.341.60.04914.0132.00.9943.30.499.560white5.64232427193792
686.30.30.341.60.04914.0132.00.9943.30.499.560white5.64232427193792
696.30.30.918.20.03450.0199.00.993943.390.4911.760white5.83403206905086
706.30.30.918.20.03450.0199.00.993943.390.4911.760white5.83403206905086
716.30.360.282.50.03518.073.00.988683.10.4712.871white6.40137276616724
726.30.40.3210.60.04938.0209.00.99813.470.599.360white5.39252598579071
736.30.510.132.30.07629.040.00.995743.420.7511.060red5.31358254041166
746.30.550.4513.00.04733.0182.00.99743.20.469.260white5.46425554217873
756.30.6950.5512.90.05658.0252.00.998063.290.498.750white5.24237533330711
766.40.180.2817.050.04753.0139.00.997243.250.3510.560white5.97777068141752
776.40.210.35.60.04443.0160.00.99493.60.4110.660white5.77901013922298
786.40.210.511.60.04245.0153.00.99723.150.438.850white5.68091187651899
796.40.220.341.40.02356.0115.00.989583.180.711.760white6.33164458042091
806.40.230.354.60.03943.0147.00.992163.180.411.071white6.09768189885585
816.40.240.2811.50.0534.0163.00.99693.310.459.550white5.73815356439707
826.40.250.35.50.03815.0129.00.99483.140.499.660white5.76077890343512
836.40.250.536.60.03859.0234.00.99553.030.428.850white5.66659857821278
846.40.290.322.40.01434.089.00.990083.240.6612.571white6.25994877128022
856.40.310.397.50.0457.0213.00.994753.320.4310.050white5.79515099520836
866.40.320.267.90.0553.0180.00.995143.140.59.650white5.77409694066702
876.40.350.212.10.05146.0171.00.99323.160.59.550white5.78020288184919
886.40.390.211.20.04135.0136.00.992253.150.4610.250white5.84705806157638
896.50.170.311.50.04134.0121.00.990923.060.4610.560white6.20111301160264
906.50.180.261.40.04140.0141.00.99413.340.729.560white5.75125144990722
916.50.180.4114.20.03947.0129.00.996783.280.7210.371white5.90811646286849
926.50.180.4114.20.03947.0129.00.996783.280.7210.371white5.90811646286849
936.50.190.265.20.0431.0140.00.9953.260.689.560white5.78450236229327
946.50.20.249.20.04425.0150.00.995023.220.4410.550white5.95361003164243
956.50.210.372.50.04870.0138.00.99173.330.7511.471white6.09405571438998
966.50.220.271.60.03936.0116.00.991783.380.5711.071white6.05638751920083
976.50.220.458.00.05352.0196.00.99593.230.489.160white5.72118948172303
986.50.220.458.00.05352.0196.00.99593.230.489.160white5.72118948172303
996.50.240.298.20.04332.0156.00.994533.130.710.160white5.94049659002059
1006.50.260.341.40.0425.0184.00.992163.290.4610.750white5.95182354018553
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.