Loading...

verticapy.machine_learning.vertica.linear_model.Ridge.predict

Ridge.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    | 151.19029 | 6.80520|22.21686 | 0.00000
 fixed_acidity  |  0.14529  | 0.01228|11.82989 | 0.00000
volatile_acidity| -0.67683  | 0.08965|-7.54978 | 0.00000
  citric_acid   | -0.16071  | 0.09430|-1.70425 | 0.08839
 residual_sugar |  0.04325  | 0.00383|11.29629 | 0.00000
   chlorides    | -0.10499  | 0.37839|-0.27745 | 0.78144
    density     |-147.15298 | 6.92189|-21.25909| 0.00000


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


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_2119e828979a11efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_21649116979a11efa8720242ac120002_"', '"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|5199 

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.40.320.394.30.0331.0127.00.989043.460.3612.881white6.19293153203733
25.00.270.324.50.03258.0178.00.989563.450.3112.671white6.25711587731135
35.00.380.011.60.04826.060.00.990843.70.7514.060red5.91702498697575
45.10.210.281.40.04748.0148.00.991683.50.4910.450white5.87107012248691
55.30.240.331.30.03325.097.00.99063.590.3811.081white6.02785727338394
65.40.2050.1612.550.05131.0115.00.995643.40.3810.860white5.83641300963612
75.40.290.381.20.02931.0132.00.988953.280.3612.460white6.23940634052445
85.40.450.276.40.03320.0102.00.989443.220.2713.481white6.30116424429454
95.40.530.162.70.03634.0128.00.988563.20.5313.281white6.23385192355263
105.40.590.077.00.04536.0147.00.99443.340.579.760white5.53336082680048
115.60.190.312.70.02711.0100.00.989643.460.413.271white6.31094562457753
125.60.230.258.00.04331.0101.00.994293.190.4210.460white5.83679661522416
135.60.290.050.80.03811.030.00.99243.360.359.250white5.7955756678831
145.60.340.11.30.03120.068.00.99063.360.5111.271white6.04093362641291
155.60.410.227.10.0544.0154.00.99313.30.410.550white5.8552406031246
165.60.50.092.30.04917.099.00.99373.630.6313.050red5.51943313394185
175.70.180.224.20.04225.0111.00.9943.350.399.450white5.76841919913906
185.70.220.2216.650.04439.0110.00.998553.240.489.060white5.61004729900466
195.70.250.211.50.04421.0108.00.991423.30.5911.060white5.98531885773627
205.70.2550.651.20.07917.0137.00.993073.20.429.450white5.65177046844909
215.70.330.151.90.0520.093.00.99343.380.629.950white5.66612187771204
225.70.3850.0412.60.03422.0115.00.99643.280.639.960white5.66956568561343
235.80.190.494.90.0444.0118.00.99353.340.389.571white5.83684913254223
245.80.250.2811.10.05645.0175.00.997553.420.439.550white5.50048640008549
255.80.340.167.00.03726.0116.00.99493.460.4510.071white5.67348350523449
265.80.390.477.50.02712.088.00.99073.380.4514.060white6.23053898964497
275.80.5550.264.50.05317.0126.00.99433.240.469.150white5.49038157171324
285.90.20.231.50.03738.093.00.990213.360.4912.060white6.2237938377944
295.90.230.288.60.04637.0142.00.994323.230.5310.660white5.89678184030524
305.90.290.321.40.02217.047.00.98993.350.3511.560white6.19128229153191
315.90.340.312.00.0338.0142.00.988923.40.4112.971white6.32836756300262
325.90.350.472.20.1114.0138.00.99323.090.59.150white5.6663218611007
336.00.160.221.60.04236.0106.00.99053.240.3211.460white6.2281286652196
346.00.240.271.90.04840.0170.00.99383.640.5410.071white5.69268668720397
356.00.280.2417.80.04742.0111.00.998963.10.458.960white5.59889882560418
366.00.360.393.20.02720.0125.00.9913.380.3911.371white6.06263915387703
376.00.420.192.00.07522.047.00.995223.390.7810.060red5.37624674750418
386.00.520.337.70.04624.0119.00.992243.040.3811.060white5.97414730542016
396.10.170.4215.10.03328.0124.00.996842.870.479.550white5.8556115936743
406.10.240.261.70.03361.0134.00.99033.190.8111.971white6.21678288555395
416.10.280.2419.950.07432.0174.00.999223.190.449.360white5.66531981250387
426.10.30.562.80.04447.0179.00.99243.30.5710.971white5.86535838153455
436.10.320.251.80.0865.032.00.994643.360.4410.150red5.52436011579425
446.10.340.251.80.0844.028.00.994643.360.4410.150red5.51103344191586
456.10.350.071.40.06922.0108.00.99343.230.529.250white5.69993757810997
466.10.380.143.90.0627.0113.00.993443.070.349.240white5.77156565344299
476.10.380.143.90.0627.0113.00.993443.070.349.240white5.77156565344299
486.10.410.01.60.06336.087.00.99143.270.6710.860white5.97416314393138
496.20.190.294.30.04533.0126.00.996583.180.429.360white5.44740033806326
506.20.20.2515.00.0558.0120.00.997673.190.539.660white5.74838445280409
516.20.20.2911.80.03521.093.00.993643.180.3411.960white6.1986836114076
526.20.250.4415.80.05739.0167.00.998043.140.519.250white5.66395103534043
536.20.270.328.80.04765.0224.00.99613.170.478.950white5.65347908372948
546.20.270.491.40.0520.074.00.99313.320.449.860white5.74725538325615
556.20.280.571.00.04350.092.00.990043.170.3611.560white6.16135346208338
566.20.30.333.50.03737.0155.00.989873.180.3712.460white6.32015712454913
576.20.330.144.80.05227.0128.00.994753.210.489.450white5.66693016064113
586.20.460.254.40.06662.0207.00.99393.250.529.850white5.66757424398097
596.20.580.01.60.0658.018.00.99663.560.849.450red5.10822492341586
606.30.230.2217.450.05442.0151.00.998533.120.69.360white5.72694447988243
616.30.270.187.70.04845.0186.00.99623.230.479.050white5.62811241603245
626.30.270.232.90.04713.0100.00.99363.280.439.850white5.795181611386
636.30.270.255.80.03852.0155.00.9953.280.389.460white5.71232193511156
646.30.290.46.50.03943.0167.00.99533.150.449.360white5.66070262375405
656.30.330.217.90.06636.0161.00.99913.140.518.850white5.59680072212117
666.30.410.160.90.03225.098.00.992743.160.429.550white5.75330195852126
676.30.410.33.20.0349.0164.00.99273.530.7911.771white5.83637271917632
686.31.020.02.00.08317.024.00.994373.590.5511.240red5.16850869764639
696.40.140.311.20.03453.0138.00.990843.380.3511.571white6.21882454314462
706.40.260.2510.70.04666.0179.00.996063.170.559.960white5.78871998626818
716.40.270.324.50.2461.0174.00.99483.120.489.450white5.66759984854474
726.40.280.178.30.04261.0195.00.995773.220.469.450white5.72733542416964
736.40.290.571.00.0615.0120.00.99243.060.419.550white5.8345768681979
746.40.30.362.00.05218.0141.00.992733.380.5310.560white5.85708664400713
756.40.310.281.50.03712.0119.00.99193.320.5110.471white5.96526209817887
766.40.310.538.80.05736.0221.00.996423.170.449.150white5.57357541640792
776.40.330.315.50.04842.0173.00.99513.190.669.360white5.64785812501478
786.40.350.281.10.0559.0160.00.994053.420.59.171white5.60262029140273
796.40.380.268.20.04328.098.00.992342.990.3111.460white6.14549308179073
806.40.410.016.10.04820.070.00.993623.190.4210.050white5.88566070754425
816.40.4750.061.00.039.0131.00.99042.970.2910.850white6.08878054390081
826.50.150.555.90.04575.0162.00.994822.970.49.350white5.80446395616596
836.50.190.11.30.04623.0107.00.99373.290.4510.050white5.81546838027916
846.50.190.281.40.04622.090.00.990383.180.5111.771white6.27941345093757
856.50.20.353.90.0427.0140.00.991022.980.5311.860white6.2759714227698
866.50.210.355.70.04347.0197.00.993923.240.510.160white5.91999375346046
876.50.220.191.10.06436.0191.00.992973.050.59.560white5.87758151279249
886.50.240.3917.30.05222.0126.00.998883.110.479.260white5.66413199260694
896.50.250.329.90.04541.0128.00.996363.180.529.660white5.72012679884665
906.50.260.311.30.03459.0145.00.989443.160.5412.460white6.36247257168728
916.50.270.194.20.0466.0114.00.99553.250.358.640white5.6074063439392
926.50.270.196.60.04598.0175.00.993643.160.3410.160white5.98501490804486
936.50.280.343.60.0429.0121.00.991113.280.4812.171white6.19721328782063
946.50.280.349.90.03830.0133.00.99543.110.449.850white5.83860939979533
956.50.320.1211.50.03335.0165.00.99743.220.329.050white5.62231061737972
966.50.330.388.30.04868.0174.00.994923.140.59.650white5.7987235991975
976.50.440.497.70.04516.0169.00.99573.110.378.760white5.56617981708251
986.50.460.142.40.1149.037.00.997323.660.659.850red5.13403690947717
996.50.880.035.60.07923.047.00.995723.580.511.240red5.24496342776044
1006.60.150.326.00.03359.0128.00.991923.190.7112.181white6.28828447980297
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.