Loading...

verticapy.machine_learning.vertica.linear_model.LogisticRegression.predict_proba

LogisticRegression.predict_proba(vdf: Annotated[str | vDataFrame, ''], X: Annotated[str | list[str], 'STRING representing one column or a list of columns'] | None = None, name: str | None = None, pos_label: Annotated[bool | float | str | timedelta | datetime, 'Python Scalar'] | None = None, inplace: bool = True) vDataFrame

Returns the model’s probabilities 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 vDataColumn. If empty, a name is generated.

pos_label: PythonScalar, optional

Class label. For binary classification, this can be either 1 or 0.

inplace: bool, optional

If set to True, the prediction is added to the vDataFrame.

Returns

vDataFrame

the input object.

Examples

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
train, test = data.train_test_split(test_size = 0.5)

Let’s import the model:

from verticapy.machine_learning.vertica import LogisticRegression

Then we can create the model:

model = LogisticRegression(
    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",
    ],
    "good",
    test,
)



=======
details
=======
   predictor    |coefficient|std_err | z_value |p_value 
----------------+-----------+--------+---------+--------
   Intercept    | 424.11398 |31.58406|13.42810 | 0.00000
 fixed_acidity  |  0.40629  | 0.05625| 7.22279 | 0.00000
volatile_acidity| -1.05805  | 0.42134|-2.51117 | 0.01203
  citric_acid   |  0.45964  | 0.41899| 1.09701 | 0.27264
 residual_sugar |  0.12977  | 0.01745| 7.43605 | 0.00000
   chlorides    | -2.92208  | 2.40054|-1.21726 | 0.22350
    density     |-431.31122 |32.12773|-13.42489| 0.00000


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


===========
call_string
===========
logistic_reg('"public"."_verticapy_tmp_logisticregression_v_mldb_afb251e8979911efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_b006a932979911efa8720242ac120002_"', '"good"', '"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  |  5  
rejected_row_count|  0  
accepted_row_count|3246 
model.predict_proba(
    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_0
Float(22)
123
prediction_1
Float(22)
13.90.2250.44.20.0329.0118.00.9893.570.3612.881white0.6142231439287930.385776856071207
24.70.3350.141.30.03669.0168.00.992123.470.4610.550white0.8924020554402550.107597944559745
34.70.4550.181.90.03633.0106.00.987463.210.8314.071white0.5340280385238430.465971961476157
44.70.7850.03.40.03623.0134.00.989813.530.9213.860white0.800135179238380.19986482076162
54.90.3450.341.00.06832.0143.00.991383.240.410.150white0.8539815790928060.146018420907194
64.90.3450.341.00.06832.0143.00.991383.240.410.150white0.8539815790928060.146018420907194
75.00.310.06.40.04643.0166.00.9943.30.639.960white0.9011242033044460.0988757966955535
85.00.40.54.30.04629.080.00.99023.490.6613.660red0.670118364066550.32988163593345
95.00.440.0418.60.03938.0128.00.99853.370.5710.260white0.9350011716375760.0649988283624239
105.10.110.321.60.02812.090.00.990083.570.5212.260white0.6659709928977360.334029007102264
115.10.1650.225.70.04742.0146.00.99343.180.559.960white0.8519006256703850.148099374329615
125.10.330.221.60.02718.089.00.98933.510.3812.571white0.6523553396003880.347644660399612
135.10.390.211.70.02715.072.00.98943.50.4512.560white0.6742876144546580.325712385545342
145.20.20.273.20.04716.093.00.992353.440.5310.171white0.8312563772699660.168743622730034
155.20.220.466.20.06641.0187.00.993623.190.429.7333333333333350white0.8509864533056880.149013546694312
165.20.310.22.40.02727.0117.00.988863.560.4513.071white0.5703347627031470.429665237296853
175.20.360.021.60.03124.0104.00.98963.440.3512.260white0.7013071408447820.298692859155218
185.20.3650.0813.50.04137.0142.00.9973.460.399.960white0.9246931009241460.0753068990758541
195.20.480.041.60.05419.0106.00.99273.540.6212.271red0.91494580108860.0850541989114003
205.20.50.182.00.03623.0129.00.989493.360.7713.471white0.6991750931863060.300824906813694
215.30.160.391.00.02840.0101.00.991563.570.5910.660white0.7934241923607190.206575807639281
225.30.230.560.90.04146.0141.00.991193.160.629.750white0.774342262912430.22565773708757
235.30.360.276.30.02840.0132.00.991863.370.411.660white0.7415545530964820.258445446903518
245.30.360.276.30.02840.0132.00.991863.370.411.660white0.7415545530964820.258445446903518
255.30.470.112.20.04816.089.00.991823.540.8813.671red0.8602349202506670.139765079749333
265.30.7150.191.50.1617.062.00.993953.620.6111.050red0.9670551922755710.0329448077244286
275.40.220.291.20.04569.0152.00.991783.760.6311.071white0.8224620190279750.177537980972025
285.50.120.331.00.03823.0131.00.991643.250.459.850white0.788083838671990.21191616132801
295.50.140.274.60.02922.0104.00.99493.340.449.050white0.9067644022326770.0932355977673228
305.50.180.225.50.03710.086.00.991563.460.4412.250white0.69126933845040.3087306615496
315.50.240.451.70.04622.0113.00.992243.220.4810.050white0.8287149132060660.171285086793934
325.50.350.351.10.04514.0167.00.9923.340.689.960white0.8468780724201450.153121927579855
335.60.150.265.550.05151.0139.00.993363.470.511.060white0.8214327201216210.178567279878379
345.60.1850.197.10.04836.0110.00.994383.260.419.560white0.8612029169087240.138797083091276
355.60.280.284.20.04452.0158.00.9923.350.4410.771white0.772519293066070.22748070693393
365.60.490.134.50.03917.0116.00.99073.420.913.771white0.7108429931657060.289157006834294
375.60.490.134.50.03917.0116.00.99073.420.913.771white0.7108429931657060.289157006834294
385.70.150.4711.40.03549.0128.00.994563.030.3410.581white0.7503707155953310.249629284404669
395.70.20.32.50.04638.0125.00.992763.340.59.960white0.8378580896861190.162141910313881
405.70.210.374.50.0458.0140.00.993323.290.6210.660white0.8299456665156620.170054333484338
415.70.220.216.00.04441.0113.00.998623.220.468.960white0.9226730076955680.0773269923044318
425.70.220.216.00.04441.0113.00.998623.220.468.960white0.9226730076955680.0773269923044318
435.70.220.216.00.04441.0113.00.998623.220.468.960white0.9226730076955680.0773269923044318
445.70.220.293.50.0427.0146.00.989993.170.3612.160white0.580809797520020.41919020247998
455.70.230.289.650.02526.0121.00.99253.280.3811.360white0.6415144370564290.358485562943571
465.70.250.2612.50.04952.5106.00.996913.080.459.460white0.901558458358120.0984415416418801
475.70.250.2612.50.04952.5120.00.996913.080.459.460white0.901558458358120.0984415416418801
485.70.250.2711.50.0424.0120.00.994113.330.3110.860white0.7513577020748790.248642297925121
495.70.260.2417.80.05923.0124.00.997733.30.510.150white0.8731990099432530.126800990056747
505.70.260.2417.80.05923.0124.00.997733.30.510.150white0.8731990099432530.126800990056747
515.70.270.321.20.04620.0155.00.99343.80.4110.260white0.8958545106624890.104145489337511
525.70.320.181.40.02926.0104.00.99063.440.3711.060white0.7282852735036130.271714726496387
535.70.320.384.750.03323.094.00.9913.420.4211.871white0.6555424264279270.344457573572073
545.80.140.156.10.04227.0123.00.993623.060.69.960white0.8174661130302510.182533886969749
555.80.150.321.20.03714.0119.00.991373.190.510.260white0.7469730540885690.253026945911431
565.80.170.341.80.04596.0170.00.990353.380.911.881white0.6456741394017910.354325860598209
575.80.180.371.10.03631.096.00.989423.160.4812.060white0.5647077921678710.435292207832129
585.80.220.290.90.03434.089.00.989363.140.3611.171white0.5826387946560890.417361205343911
595.80.220.291.30.03625.068.00.988653.240.3512.660white0.4953301753690260.504669824630974
605.80.260.181.20.03140.0114.00.99083.420.411.071white0.7310366108459460.268963389154054
615.80.260.181.20.03140.0114.00.99083.420.411.071white0.7310366108459460.268963389154054
625.80.280.181.20.0587.0108.00.992883.230.589.5540white0.8804894041815610.119510595818439
635.80.280.284.20.04452.0158.00.9923.350.4410.771white0.7579242480449490.242075751955051
645.80.290.333.70.02930.088.00.989943.250.4212.360white0.5650011798022940.434998820197706
655.80.320.284.30.03246.0115.00.989463.160.5713.081white0.5100192065079910.489980793492009
665.80.320.284.30.03246.0115.00.989463.160.5713.081white0.5100192065079910.489980793492009
675.80.320.384.750.03323.094.00.9913.420.4211.871white0.6463109711998620.353689028800138
685.80.3850.253.70.03138.0122.00.991283.20.6311.260white0.7276181884844070.272381811515593
695.80.610.018.40.04131.0104.00.99093.260.7214.0571white0.6425260713871240.357473928612876
705.90.140.254.50.02734.0140.00.99343.490.5110.860white0.8148132743805020.185186725619498
715.90.150.315.80.04153.0155.00.99453.520.4610.560white0.8595123517603950.140487648239605
725.90.170.31.40.04225.0119.00.99313.680.7210.560white0.8590088519967310.140991148003269
735.90.190.211.70.04557.0135.00.993413.320.449.550red0.8779492697044160.122050730295584
745.90.190.211.70.04557.0135.00.993413.320.449.550white0.8779492697044160.122050730295584
755.90.190.370.80.0273.021.00.98973.090.3110.850white0.5899216973926210.410078302607379
765.90.210.237.90.03322.0130.00.99443.380.5910.960white0.8281358332384010.171864166761599
775.90.230.241.60.03732.0115.00.990763.210.5111.460white0.7002126385338630.299787361466137
785.90.230.243.80.03861.0152.00.991393.310.511.371white0.6979305044789350.302069495521065
795.90.260.242.40.04627.0132.00.992343.630.7311.350white0.8151768666619210.184823133338079
805.90.270.275.00.03514.097.00.990583.10.3311.871white0.5871368354762050.412863164523795
815.90.290.337.40.03758.0205.00.994953.260.419.650white0.8726891840463110.127310815953689
825.90.330.328.10.0389.034.00.99113.220.3612.771white0.5556190165900060.444380983409994
835.90.4150.020.80.03822.063.00.99323.360.369.350white0.9092332722352220.0907667277647784
845.90.440.01.60.0423.011.00.99443.480.8511.760red0.9407770968623140.0592229031376858
855.90.620.283.50.03955.0152.00.99073.440.4412.060white0.7263069371188010.273693062881199
866.00.160.36.70.04343.0153.00.99513.630.4610.650white0.8736506672356490.126349332764351
876.00.170.299.70.04433.098.00.995363.120.369.260white0.8421824071243970.157817592875603
886.00.190.291.10.04767.0152.00.99163.540.5911.171white0.7683085768047120.231691423195288
896.00.20.266.80.04922.093.00.99283.150.4211.060white0.7324085738535110.267591426146489
906.00.210.380.80.0222.098.00.989413.260.3211.860white0.5483588804637570.451641119536243
916.00.250.45.70.05256.0152.00.993983.160.8810.560white0.8396857840543740.160314215945626
926.00.260.241.30.05366.0150.00.99243.210.6210.460white0.8365060541322710.163493945867729
936.00.260.323.80.02948.0180.00.990113.150.3412.060white0.5531549686852710.446845031314729
946.00.270.191.70.0224.0110.00.98983.320.4712.671white0.5977921010610810.402207898938919
956.00.270.314.70.04415.0144.00.996663.120.5310.360white0.8439102096211160.156089790378884
966.00.280.2715.50.03631.0134.00.994083.190.4413.071white0.615858888369250.38414111163075
976.00.280.351.90.03716.0120.00.99333.160.6910.650white0.8660670095843780.133932990415622
986.00.370.321.00.05331.0218.50.99243.290.729.860white0.8520793440545540.147920655945446
996.00.380.263.50.03538.0111.00.988723.180.4713.671white0.4563394855387030.543660514461297
1006.00.390.1712.00.04665.0246.00.99763.150.389.060white0.9331423756136540.0668576243863464
Rows: 1-100 | Columns: 16

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.