Loading...

verticapy.machine_learning.vertica.ensemble.RandomForestRegressor.predict

RandomForestRegressor.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    | 152.83148 | 6.86313|22.26850 | 0.00000
 fixed_acidity  |  0.15234  | 0.01233|12.35351 | 0.00000
volatile_acidity| -0.81621  | 0.08679|-9.40424 | 0.00000
  citric_acid   | -0.20582  | 0.09342|-2.20321 | 0.02762
 residual_sugar |  0.04417  | 0.00381|11.57913 | 0.00000
   chlorides    |  0.01548  | 0.38387| 0.04033 | 0.96783
    density     |-148.79647 | 6.97981|-21.31813| 0.00000


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


===========
call_string
===========
linear_reg('"public"."_verticapy_tmp_linearregression_v_mldb_697511b2979811efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_69e76d0c979811efa8720242ac120002_"', '"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.18505591245724
24.40.460.12.80.02431.0111.00.988163.480.3413.160white6.19506298588746
34.40.540.095.10.03852.097.00.990223.410.412.271white5.92711881203462
45.00.380.011.60.04826.060.00.990843.70.7514.060red5.91887488890768
55.10.470.021.30.03418.044.00.99213.90.6212.860red5.65763956207155
65.10.5850.01.70.04414.086.00.992643.560.9412.971red5.50536613033097
75.30.310.3810.50.03153.0140.00.993213.340.4611.760white5.98578720228116
85.30.310.3810.50.03153.0140.00.993213.340.4611.760white5.98578720228116
95.30.5850.077.10.04434.0145.00.99453.340.579.760white5.48319960630502
105.40.180.244.80.04130.0113.00.994453.420.49.460white5.69980296728019
115.40.290.381.20.02931.0132.00.988953.280.3612.460white6.24037705353649
125.40.530.162.70.03634.0128.00.988563.20.5313.281white6.21416640941061
135.40.590.077.00.04536.0147.00.99443.340.579.760white5.50483010977015
145.60.180.271.70.0331.0103.00.988923.350.3712.960white6.40983335334977
155.60.190.461.10.03233.0115.00.99093.360.510.460white6.04147561543721
165.60.20.6610.20.04378.0175.00.99452.980.4310.471white5.85862799834314
175.60.2250.249.80.05459.0140.00.995453.170.3910.260white5.76581148821353
185.60.340.252.50.04647.0182.00.990933.210.411.350white6.01986193100282
195.60.460.244.80.04224.072.00.99083.290.3712.660white6.04485509776364
205.60.50.092.30.04917.099.00.99373.630.6313.050red5.50124556552987
215.70.140.35.40.04526.0105.00.994693.320.459.350white5.75665786893768
225.70.220.2216.650.04439.0110.00.998553.240.489.060white5.63040463295303
235.70.2450.331.10.04928.0150.00.99273.130.429.350white5.77100404532158
245.80.20.241.40.03365.0169.00.990433.590.5612.371white6.19226307983428
255.80.20.271.40.03112.077.00.99053.250.3610.971white6.17564177354035
265.80.3150.271.550.02615.070.00.989943.370.411.981white6.17165257023558
275.80.320.312.70.04925.0153.00.990673.440.7312.271white6.10187248145789
285.90.170.280.70.0275.028.00.989853.130.3210.650white6.2790381026019
295.90.220.31.30.05242.086.00.990693.310.4711.5560white6.13601323190409
305.90.230.288.60.04637.0142.00.994323.230.5310.660white5.91420725055258
315.90.240.281.30.03236.095.00.988893.080.6412.971white6.39132951601283
325.90.240.32.00.03328.092.00.992253.390.6910.971white5.91819363418085
335.90.250.1912.40.04750.0162.00.99733.350.389.550white5.6408667319505
345.90.260.2718.20.04852.0168.00.99933.350.449.450white5.5748657232669
355.90.270.279.00.05143.0136.00.99413.250.5310.760white5.9340990517116
365.90.320.284.70.03934.094.00.989643.220.5713.171white6.36473259096783
375.90.4150.131.40.0411.064.00.99223.290.5210.550white5.79139109721942
386.00.190.291.20.04629.092.00.990333.220.5311.360white6.22684788705689
396.00.240.271.90.04840.0170.00.99383.640.5410.071white5.7047823178693
406.00.240.326.30.0334.0129.00.99463.520.4110.450white5.76953722346875
416.00.270.41.70.02118.082.00.98913.240.9513.133333333333360white6.34363036351178
426.00.280.2417.80.04742.0111.00.998963.10.458.960white5.61285596901311
436.00.280.2417.80.04742.0111.00.998963.10.458.960white5.61285596901311
446.00.280.526.20.02837.0104.00.991613.280.5111.871white6.13617819596382
456.00.380.266.00.03442.0134.00.99123.380.3812.371white6.16033544400028
466.00.420.4112.40.03250.0179.00.996223.140.69.750white5.63253292710471
476.10.1250.253.30.0410.069.00.99343.540.5910.160white5.93923333224274
486.10.160.2712.60.06463.0162.00.99943.660.438.950white5.4249524285211
496.10.240.251.60.04424.0115.00.99213.390.5910.960white5.96377257778326
506.10.240.261.70.03361.0134.00.99033.190.8111.971white6.23379505277853
516.10.240.329.00.03141.0134.00.992343.250.2612.371white6.24033388523296
526.10.280.2512.90.05434.0189.00.99793.250.439.040white5.56741583213704
536.10.320.286.60.02129.0132.00.991883.150.3611.4571white6.14554619710864
546.10.340.215.00.04217.0133.00.993733.020.539.450white5.79800407324205
556.10.350.071.40.06922.0108.00.99343.230.529.250white5.70915435591084
566.10.380.143.90.0627.0113.00.993443.070.349.240white5.77460238388659
576.10.410.1410.40.03718.0119.00.9963.380.4510.050white5.65596642002353
586.10.410.241.60.04916.0137.00.9933.320.510.460white5.69323618530893
596.10.7150.12.60.05313.027.00.993623.570.511.950red5.4250890760211
606.20.160.541.40.12637.0110.00.99323.230.378.960white5.81337386196876
616.20.220.220.80.03558.0184.01.000223.110.539.060white5.64537864097841
626.20.240.2512.50.05547.0134.00.997583.30.519.050white5.64525893304693
636.20.270.491.40.0520.074.00.99313.320.449.860white5.7475851580902
646.20.280.415.00.04350.0188.00.993183.230.6410.860white5.9028998127514
656.20.30.2613.40.04657.0206.00.997753.170.439.560white5.60854940028338
666.20.310.264.80.03736.0148.00.99283.210.4110.460white5.95690170710301
676.20.350.312.60.03637.092.00.989383.270.5312.871white6.32565004299713
686.20.360.225.250.03844.0145.00.991843.220.411.260white6.08706215193024
696.20.530.020.90.0356.081.00.992343.240.359.540white5.7228731617227
706.20.560.091.70.05324.032.00.994023.540.611.350red5.4696186609327
716.30.210.281.50.05146.0142.00.99283.230.4210.160white5.90408516085387
726.30.220.331.70.04167.0164.00.99283.320.5610.460white5.89431191915295
736.30.240.558.10.0467.0216.00.995963.240.59.250white5.64520308583423
746.30.250.2314.90.03947.0142.00.997053.140.359.760white5.84107690034742
756.30.260.292.20.04335.0175.00.99183.380.4311.660white6.040810429071
766.30.270.255.80.03852.0155.00.9953.280.389.460white5.72367825867136
776.30.280.2211.50.03627.0150.00.994453.00.3310.660white6.05528466894643
786.30.290.46.50.03943.0167.00.99533.150.449.360white5.6627788925361
796.30.390.246.90.0699.0117.00.99423.150.3510.240white5.79589916369716
806.30.410.160.90.03225.098.00.992743.160.429.550white5.74767191871265
816.30.410.33.20.0349.0164.00.99273.530.7911.771white5.8263762380553
826.30.410.334.70.02328.0110.00.9913.30.3812.571white6.1393069666984
836.30.480.041.10.04630.099.00.99283.240.369.660white5.71535937334517
846.40.130.471.60.09240.0158.00.99283.210.369.860white5.95056173803025
856.40.140.311.20.03453.0138.00.990843.380.3511.571white6.24840474431844
866.40.150.311.10.04425.096.00.99323.540.5110.360white5.88482049673382
876.40.260.2510.70.04666.0179.00.996063.170.559.960white5.8059219294436
886.40.260.496.40.03737.0161.00.99543.380.539.760white5.66464712641226
896.40.290.243.20.03731.095.00.989422.90.6612.671white6.44006477064951
906.40.290.2811.10.06366.0169.00.99732.890.579.050white5.60868593497869
916.40.290.571.00.0615.0120.00.99243.060.419.550white5.83190598514065
926.40.310.281.50.03712.0119.00.99193.320.5110.471white5.97139828329125
936.40.380.268.20.04328.098.00.992342.990.3111.460white6.14896254602056
946.50.080.331.90.02823.093.00.9913.340.712.071white6.31551534539898
956.50.190.341.60.02939.0116.00.989543.210.6812.560white6.42768079001783
966.50.20.353.90.0427.0140.00.991022.980.5311.860white6.29901021506822
976.50.210.5117.60.04534.0125.00.999663.20.478.860white5.57756462306779
986.50.220.191.10.06436.0191.00.992973.050.59.560white5.90215091377422
996.50.220.283.70.05929.0151.00.991773.230.4112.171white6.17695562004292
1006.50.230.3616.30.03843.0133.00.999243.260.418.850white5.59707453064911
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.