Loading...

verticapy.machine_learning.vertica.linear_model.LinearRegression.predict#

LinearRegression.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.60.520.152.10.0548.065.00.99343.90.5613.140red5.36454223708637
24.70.60.172.30.05817.0106.00.99323.850.612.960red5.34950848159551
34.90.470.171.90.03560.0148.00.989643.270.3511.560white5.96431803763787
45.00.2550.222.70.04346.0153.00.992383.750.7611.360white5.79203084520782
55.00.270.324.50.03258.0178.00.989563.450.3112.671white6.24039589072191
65.00.330.161.50.04910.097.00.99173.480.4410.760white5.78359513526632
75.00.330.184.60.03240.0124.00.991143.180.411.060white5.99206074568977
85.01.040.241.60.0532.096.00.99343.740.6211.550red4.98122501303263
95.10.210.281.40.04748.0148.00.991683.50.4910.450white5.87782477887149
105.10.330.221.60.02718.089.00.98933.510.3812.571white6.13352823372043
115.10.350.266.80.03436.0120.00.991883.380.411.560white5.97050283466228
125.10.420.01.80.04418.088.00.991573.680.7313.671red5.776353300202
135.20.170.270.70.0311.068.00.992183.30.419.850white5.82729644855903
145.20.30.341.50.03818.096.00.989423.560.4813.081white6.13578506849339
155.20.310.22.40.02727.0117.00.988863.560.4513.071white6.26109577144086
165.20.3350.21.70.03317.074.00.990023.340.4812.360white6.04899982574329
175.20.490.262.30.0923.074.00.99533.710.6212.260red5.20044531544502
185.30.1650.241.10.05125.0105.00.99253.320.479.150white5.81868736365357
195.30.2750.247.40.03828.0114.00.993133.380.5111.060white5.91050294238704
205.30.320.126.60.04322.0141.00.99373.360.610.460white5.77457321606059
215.30.320.239.650.02626.0119.00.991683.180.5312.260white6.17502362832792
225.30.470.112.20.04816.089.00.991823.540.8813.671red5.7346451217102
235.30.5850.077.10.04434.0145.00.99453.340.579.760white5.48034244887603
245.30.60.341.40.0313.060.00.988543.270.3813.060white6.03328966881429
255.40.1850.197.10.04836.0110.00.994383.260.419.560white5.8128203818267
265.40.2050.1612.550.05131.0115.00.995643.40.3810.860white5.85327588320612
275.40.220.291.20.04569.0152.00.991783.760.6311.071white5.88962172202275
285.40.230.361.50.0374.0121.00.989763.240.9912.171white6.17070536275898
295.40.290.381.20.02931.0132.00.988953.280.3612.460white6.22193919458149
305.40.3750.43.30.05429.0147.00.994823.420.529.150white5.41724004210425
315.40.420.272.00.09223.055.00.994713.780.6412.371red5.35283436132886
325.40.460.152.10.02629.0130.00.989533.390.7713.481white6.07090629320226
335.40.50.135.00.02812.0107.00.990793.480.8813.571white5.98723821182233
345.40.530.162.70.03634.0128.00.988563.20.5313.281white6.17442589273844
355.40.590.077.00.04536.0147.00.99443.340.579.760white5.50039761242206
365.50.140.274.60.02922.0104.00.99493.340.449.050white5.6777582093134
375.50.240.328.70.0619.0102.00.9943.270.3110.450white5.88833704407364
385.50.30.251.90.02933.0118.00.989723.360.6612.560white6.16477861880927
395.50.310.293.00.02716.0102.00.990673.230.5611.260white6.06604075472166
405.50.3350.32.50.07127.0128.00.99243.140.519.660white5.77728552027287
415.50.4850.01.50.0658.0103.00.9943.630.49.740white5.42757479702391
425.60.130.274.80.02822.0104.00.99483.340.459.260white5.72248858233564
435.60.150.265.550.05151.0139.00.993363.470.511.060white5.9382832490264
445.60.180.292.30.045.047.00.991263.070.4510.140white6.06940849706737
455.60.180.581.250.03429.0129.00.989843.510.612.071white6.19186311185229
465.60.1850.197.10.04836.0110.00.994383.260.419.560white5.84147995449038
475.60.190.270.90.0452.0103.00.990263.50.3911.250white6.14471751511255
485.60.190.474.50.0319.0112.00.99223.560.4511.260white6.00350930288235
495.60.2350.291.20.04733.0127.00.9913.340.511.071white6.01533729089002
505.60.250.192.40.04942.0166.00.9923.250.4310.460white5.92518376962616
515.60.260.010.20.03813.0111.00.993153.440.4612.460white6.10739460589667
525.60.260.2710.60.0327.0119.00.99473.40.3410.771white5.87793203635999
535.60.260.511.40.02925.093.00.994283.230.4910.560white5.94458466244186
545.60.2950.261.10.03540.0102.00.991543.470.5610.660white5.8930084338057
555.60.30.16.40.04334.0142.00.993823.140.489.850white5.81037469151553
565.60.390.244.70.03427.077.00.99063.280.3612.750white6.10351047559797
575.60.620.031.50.086.013.00.994983.660.6210.140red5.19336586502303
585.60.660.02.20.0873.011.00.993783.710.6312.871red5.3617494749904
595.60.660.02.20.0873.011.00.993783.710.6312.871red5.3617494749904
605.60.6950.066.80.0429.084.00.994323.440.4410.250white5.45051755648564
615.60.9150.02.10.04117.078.00.993463.680.7311.450red5.20640233356235
625.70.1350.34.60.04219.0101.00.99463.310.429.360white5.74750053948117
635.70.150.4711.40.03549.0128.00.994563.030.3410.581white6.00916915864727
645.70.160.266.30.04328.0113.00.99363.060.589.960white5.94362128215408
655.70.210.251.10.03526.081.00.99023.310.5211.460white6.16289982776698
665.70.220.2216.650.04439.0110.00.998553.240.489.060white5.64402297101464
675.70.240.31.30.0325.098.00.989683.370.4312.471white6.2153347747805
685.70.240.476.30.06935.0182.00.993913.110.469.7333333333333350white5.81067545924873
695.70.2550.651.20.07917.0137.00.993073.20.429.450white5.68029105234177
705.70.260.2417.80.05923.0124.00.997733.30.510.150white5.77168112957955
715.70.260.2510.40.027.057.00.9943.390.3710.650white5.98511753550667
725.70.280.282.20.01915.065.00.99023.060.5211.260white6.15242813206751
735.70.320.384.750.03323.094.00.9913.420.4211.871white6.10353116093762
745.70.330.321.40.04328.093.00.98973.310.512.360white6.14210587472667
755.70.3350.341.00.0413.0174.00.9923.270.6610.050white5.79769651504967
765.70.3850.0412.60.03422.0115.00.99643.280.639.960white5.66556848380034
775.70.390.254.90.03349.0113.00.989663.260.5813.171white6.2567277476625
785.70.430.35.70.03924.098.00.9923.540.6112.371white5.92527187291981
795.70.450.421.10.05161.0197.00.99323.020.49.050white5.53317846526468
805.70.60.01.40.06311.018.00.991913.450.5612.260red5.65393381495983
815.70.6950.066.80.0429.084.00.994323.440.4410.250white5.46484734281748
825.80.130.2212.70.05824.0183.00.99563.320.4211.760white5.97409519196188
835.80.130.2212.70.05824.0183.00.99563.320.4211.760white5.97409519196188
845.80.140.156.10.04227.0123.00.993623.060.69.960white5.97498980713101
855.80.150.280.80.03743.0127.00.991983.240.519.350white5.9593218284779
865.80.150.321.20.03714.0119.00.991373.190.510.260white6.05698252942872
875.80.170.341.80.04596.0170.00.990353.380.911.881white6.20600685306954
885.80.170.341.80.04596.0170.00.990353.380.911.881white6.20600685306954
895.80.180.281.30.0349.094.00.990923.210.5211.260white6.10532228330507
905.80.20.241.40.03365.0169.00.990433.590.5612.371white6.16691749917939
915.80.220.291.30.03625.068.00.988653.240.3512.660white6.38995975419107
925.80.230.313.50.04435.0158.00.989983.190.3712.171white6.28551355676316
935.80.260.181.20.03140.0114.00.99083.420.411.071white6.06642215534433
945.80.270.2212.70.05842.0206.00.99463.320.3812.360white6.0036111054221
955.80.280.669.10.03926.0159.00.99653.660.5510.850white5.53101925051766
965.80.290.212.60.02512.0120.00.98943.390.7914.071white6.29482369207625
975.80.30.121.60.03657.0163.00.992393.380.5910.560white5.83552407682859
985.80.30.231.50.03437.0121.00.988712.960.3412.160white6.333898329124
995.80.30.421.10.03619.0113.00.988713.10.4612.671white6.29545651316033
1005.80.310.324.50.02428.094.00.989063.250.5213.771white6.39432984977844
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.