Loading...

verticapy.machine_learning.vertica.linear_model.Ridge.predict#

Ridge.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.20.2150.235.10.04164.0157.00.996883.420.448.030white5.16691576059685
24.60.4450.01.40.05311.0178.00.994263.790.5510.250white5.31059244294727
34.80.2250.381.20.07447.0130.00.991323.310.410.360white5.82705618698472
44.90.2350.2711.750.0334.0118.00.99543.070.59.460white5.74784451188572
55.00.240.341.10.03449.0158.00.987743.320.3213.171white6.36905739912478
65.00.270.324.50.03258.0178.00.989563.450.3112.671white6.24184984983668
75.00.330.161.50.04910.097.00.99173.480.4410.760white5.78871493675834
85.00.330.2311.80.0323.0158.00.993223.410.6411.860white6.01382735112452
95.00.440.0418.60.03938.0128.00.99853.370.5710.260white5.51324441930038
105.00.4550.181.90.03633.0106.00.987463.210.8314.071white6.32079524835657
115.00.740.01.20.04116.046.00.992584.010.5912.560red5.39796400075943
125.10.110.321.60.02812.090.00.990083.570.5212.260white6.1694661157596
135.10.30.32.30.04840.0150.00.989443.290.4612.260white6.15493617120015
145.10.3050.131.750.03617.073.00.993.40.5112.333333333333350white6.08145937252218
155.20.1550.331.60.02813.059.00.989753.30.8411.981white6.19780357657376
165.20.160.340.80.02926.077.00.991553.250.5110.160white5.90319467720587
175.20.250.231.40.04720.077.00.990013.320.6211.450white6.09649487566611
185.20.320.251.80.10313.050.00.99573.380.559.250red5.2365860159282
195.20.370.331.20.02813.081.00.99023.370.3811.760white5.9684318845886
205.20.440.041.40.03643.0119.00.98943.360.3312.181white6.08747060746677
215.20.60.077.00.04433.0147.00.99443.330.589.750white5.50367396811023
225.30.160.391.00.02840.0101.00.991563.570.5910.660white5.91682822509304
235.30.160.391.00.02840.0101.00.991563.570.5910.660white5.91682822509304
245.30.40.253.90.03145.0130.00.990723.310.5811.7571white6.01745906622153
255.30.430.111.10.0296.051.00.990763.510.4811.240white5.89437152074433
265.40.180.244.80.04130.0113.00.994453.420.49.460white5.6930903159429
275.40.420.272.00.09223.055.00.994713.780.6412.371red5.34574468542002
285.40.450.276.40.03320.0102.00.989443.220.2713.481white6.2822311926455
295.40.50.135.00.02812.0107.00.990793.480.8813.571white6.02163057058911
305.40.530.162.70.03634.0128.00.988563.20.5313.281white6.2089889763545
315.40.740.01.20.04116.046.00.992584.010.5912.560red5.45562081648535
325.50.140.274.60.02922.0104.00.99493.340.449.050white5.66227626947236
335.50.180.225.50.03710.086.00.991563.460.4412.250white6.15128528126675
345.50.490.031.80.04428.087.00.99083.50.8214.081red5.91416939901987
355.60.180.271.70.0331.0103.00.988923.350.3712.960white6.36920529299084
365.60.180.581.250.03429.0129.00.989843.510.612.071white6.1662625702962
375.60.1850.197.10.04836.0110.00.994383.260.419.560white5.83345516091964
385.60.190.261.40.0312.076.00.99053.250.3710.971white6.12756797776584
395.60.190.312.70.02711.0100.00.989643.460.413.271white6.29806789572976
405.60.210.244.40.02737.0150.00.9913.30.3111.571white6.17704695796917
415.60.210.41.30.04181.0147.00.99013.220.9511.681white6.13848239334905
425.60.240.342.00.04114.073.00.989813.040.4511.671white6.19905483745558
435.60.260.181.40.03418.0135.00.991743.320.3510.260white5.91577765481276
445.60.310.371.40.07412.096.00.99543.320.589.250red5.31696972663531
455.60.340.11.30.03120.068.00.99063.360.5111.271white6.03195595706958
465.60.410.227.10.0544.0154.00.99313.30.410.550white5.85335099056994
475.60.420.342.40.02234.097.00.989153.220.3812.871white6.19242855085028
485.60.490.134.50.03917.0116.00.99073.420.913.771white6.04442021263324
495.60.660.02.20.0873.011.00.993783.710.6312.871red5.39608681431451
505.60.9150.02.10.04117.078.00.993463.680.7311.450red5.27801816774695
515.70.150.283.70.04557.0151.00.99133.220.2711.260white6.14685888330553
525.70.20.32.50.04638.0125.00.992763.340.59.960white5.85031559392294
535.70.210.321.60.0333.0122.00.990443.330.5211.960white6.13524548299685
545.70.220.216.00.04441.0113.00.998623.220.468.960white5.608165293784
555.70.220.2216.650.04439.0110.00.998553.240.489.060white5.64278257563538
565.70.220.2216.650.04439.0110.00.998553.240.489.060white5.64278257563538
575.70.220.331.90.03637.0110.00.989453.260.5812.460white6.27740473319963
585.70.230.289.650.02526.0121.00.99253.280.3811.360white6.18624936703131
595.70.250.211.50.04421.0108.00.991423.30.5911.060white5.97793596429133
605.70.250.229.80.04950.0125.00.995713.20.4510.160white5.72608030938517
615.70.250.2710.80.0558.0116.00.995923.10.59.860white5.73081604355832
625.70.250.2711.50.0424.0120.00.994113.330.3110.860white6.02073404101603
635.70.2550.651.20.07917.0137.00.993073.20.429.450white5.64150120450114
645.70.320.181.40.02926.0104.00.99063.440.3711.060white6.05184287896719
655.70.330.321.40.04328.093.00.98973.310.512.360white6.14357994895181
665.70.360.344.20.02621.077.00.99073.410.4511.960white6.10530177596954
675.70.410.211.90.04830.0112.00.991383.290.5511.260white5.8889000144265
685.70.450.421.10.05161.0197.00.99323.020.49.050white5.53305891950762
695.70.60.01.40.06311.018.00.991913.450.5612.260red5.69076067892814
705.80.170.341.80.04596.0170.00.990353.380.911.881white6.18972800152508
715.80.180.281.30.0349.094.00.990923.210.5211.260white6.09475068531668
725.80.180.371.10.03631.096.00.989423.160.4812.060white6.28243924315677
735.80.20.241.40.03365.0169.00.990433.590.5612.371white6.16162722146098
745.80.20.341.00.03540.086.00.989933.50.4211.750white6.19757915219827
755.80.210.321.60.04538.095.00.989463.230.9412.481white6.28269044614109
765.80.220.31.10.04736.0131.00.9923.260.4510.450white5.89758070131506
775.80.230.271.80.04324.069.00.99333.380.319.460white5.74355626675489
785.80.230.314.50.04642.0124.00.993243.310.6410.860white5.86081508498771
795.80.240.2610.050.03963.0162.00.993753.330.511.260white6.03240177005512
805.80.240.281.40.03840.076.00.987113.10.2913.971white6.59498703046489
815.80.270.263.50.07126.069.00.989943.10.3811.560white6.25581657139924
825.80.280.669.10.03926.0159.00.99653.660.5510.850white5.50785172844496
835.80.290.261.70.0633.011.00.99153.390.5413.560red5.94662731329996
845.80.30.231.50.03437.0121.00.988712.960.3412.160white6.34145118864595
855.80.30.421.10.03619.0113.00.988713.10.4612.671white6.29161789528334
865.80.3150.271.550.02615.070.00.989943.370.411.981white6.15556881619781
875.80.320.22.60.02717.0123.00.989363.360.7813.971white6.29083386137401
885.80.320.384.750.03323.094.00.9913.420.4211.871white6.11936060288855
895.80.350.293.20.03441.0151.00.99123.350.5811.633333333333371white6.01813280536101
905.80.360.263.30.03840.0153.00.99113.340.5511.360white6.03322797643261
915.80.360.51.00.12763.0178.00.992123.10.459.750white5.71643828904357
925.80.360.51.00.12763.0178.00.992123.10.459.750white5.71643828904357
935.80.380.261.10.05820.0140.00.992713.270.439.760white5.68930433494452
945.80.3850.253.70.03138.0122.00.991283.20.6311.260white6.01205312451529
955.80.540.01.40.03340.0107.00.989183.260.3512.450white6.14383138165346
965.80.580.01.50.0233.096.00.989183.290.3812.460white6.12535372318763
975.81.010.662.00.03915.088.00.993573.660.611.560red5.11158649304383
985.90.130.281.90.0520.078.00.99183.430.6410.860white6.0392052082139
995.90.190.211.70.04557.0135.00.993413.320.449.550red5.77502167526825
1005.90.220.186.40.04128.0120.00.994033.270.59.950white5.87607591973173
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.