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.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
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    | 420.20035 |31.31469|13.41863 | 0.00000
 fixed_acidity  |  0.39126  | 0.05404| 7.24040 | 0.00000
volatile_acidity| -1.28663  | 0.42900|-2.99916 | 0.00271
  citric_acid   |  0.11242  | 0.42560| 0.26415 | 0.79166
 residual_sugar |  0.12089  | 0.01744| 6.92998 | 0.00000
   chlorides    | -1.38942  | 2.34720|-0.59195 | 0.55389
    density     |-427.14424 |31.85381|-13.40952| 0.00000


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


===========
call_string
===========
logistic_reg('"public"."_verticapy_tmp_logisticregression_v_demo_28b243f655a411ef880f0242ac120002_"', '"public"."_verticapy_tmp_view_v_demo_28c4ffbe55a411ef880f0242ac120002_"', '"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|3249 
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.6219546189693270.378045381030673
24.20.170.361.80.02993.0161.00.989993.650.8912.071white0.7361049334328760.263895066567124
34.40.540.095.10.03852.097.00.990223.410.412.271white0.7623838409897760.237616159010224
44.70.3350.141.30.03669.0168.00.992123.470.4610.550white0.8856648262730990.114335173726901
54.70.4550.181.90.03633.0106.00.987463.210.8314.071white0.5334693310665290.466530668933471
64.70.60.172.30.05817.0106.00.99323.850.612.960red0.9402391341812780.0597608658187223
74.70.670.091.00.025.09.00.987223.30.3413.650white0.5998583269949080.400141673005092
84.70.7850.03.40.03623.0134.00.989813.530.9213.860white0.8023993863422170.197600613657783
94.80.130.321.20.04240.098.00.98983.420.6411.871white0.6799481779811030.320051822018897
104.80.170.282.90.0322.0111.00.99023.380.3411.371white0.6809564872064470.319043512793553
114.80.210.2110.20.03717.0112.00.993243.660.4812.271white0.7761323983260480.223867601673952
124.80.2250.381.20.07447.0130.00.991323.310.410.360white0.8267459786196030.173254021380397
134.90.3350.141.30.03669.0168.00.992123.470.4610.466666666666750white0.8774984964685910.122501503531409
144.90.3450.341.00.06832.0143.00.991383.240.410.150white0.8486400703764110.151359929623589
155.00.20.41.90.01520.098.00.98973.370.5512.0560white0.6437094543417420.356290545658258
165.00.240.195.00.04317.0101.00.994383.670.5710.050white0.9113120585798570.0886879414201432
175.00.240.212.20.03931.0100.00.990983.690.6211.760white0.7699716370006930.230028362999307
185.00.270.41.20.07642.0124.00.992043.320.4710.160white0.8641809545570750.135819045442925
195.00.30.333.70.0354.0173.00.98873.360.313.071white0.5260095700857740.473990429914226
205.00.330.161.50.04910.097.00.99173.480.4410.760white0.8501309445611760.149869055438824
215.00.330.161.50.04910.097.00.99173.480.4410.760white0.8501309445611760.149869055438824
225.00.330.2311.80.0323.0158.00.993223.410.6411.860white0.7512842311263280.248715768873672
235.00.350.257.80.03124.0116.00.992413.390.411.360white0.7803850517919210.219614948208079
245.00.380.011.60.04826.060.00.990843.70.7514.060red0.8078346562804330.192165343719567
255.00.40.54.30.04629.080.00.99023.490.6613.660red0.6908502551282260.309149744871774
265.00.4550.181.90.03633.0106.00.987463.210.8314.071white0.504174713849570.49582528615043
275.01.040.241.60.0532.096.00.99343.740.6211.550red0.9662872929959920.0337127070040078
285.10.140.250.70.03915.089.00.99193.220.439.260white0.8334349411124290.166565058887571
295.10.230.181.00.05313.099.00.989563.220.3911.550white0.6720571266247380.327942873375262
305.10.260.331.10.02746.0113.00.989463.350.4311.471white0.6566297322743360.343370267725664
315.10.290.288.30.02627.0107.00.993083.360.3711.060white0.7968967459149320.203103254085068
325.10.30.32.30.04840.0150.00.989443.290.4612.260white0.6407724223957580.359227577604242
335.10.330.221.60.02718.089.00.98933.510.3812.571white0.650662945445480.34933705455452
345.10.330.276.70.02244.0129.00.992213.360.3911.071white0.7748403856133230.225159614386677
355.10.350.266.80.03436.0120.00.991883.380.411.560white0.7551611606396330.244838839360367
365.10.350.266.80.03436.0120.00.991883.380.411.560white0.7551611606396330.244838839360367
375.10.420.011.50.01725.0102.00.98943.380.3612.371white0.6904596693602810.309540330639719
385.10.470.021.30.03418.044.00.99213.90.6212.860red0.8876106043761430.112389395623857
395.10.5850.01.70.04414.086.00.992643.560.9412.971red0.9178110911358750.0821889088641246
405.20.160.340.80.02926.077.00.991553.250.5110.160white0.8039511034642390.196048896535761
415.20.170.270.70.0311.068.00.992183.30.419.850white0.8474176764986890.152582323501311
425.20.210.311.70.04817.061.00.989533.240.3712.071white0.6303333175037470.369666682496253
435.20.240.157.10.04332.0134.00.993783.240.489.960white0.8514292136034650.148570786396535
445.20.240.453.80.02721.0128.00.9923.550.4911.281white0.7905940994063170.209405900593683
455.20.280.291.10.02818.069.00.991683.240.5410.060white0.8304843599466350.169515640053365
465.20.310.22.40.02727.0117.00.988863.560.4513.071white0.5682440395806490.431755960419351
475.20.3350.21.70.03317.074.00.990023.340.4812.360white0.7099830153495620.290016984650438
485.20.340.01.80.0527.063.00.99163.680.7914.060red0.833500063117260.16649993688274
495.20.340.01.80.0527.063.00.99163.680.7914.060red0.833500063117260.16649993688274
505.20.3650.0813.50.04137.0142.00.9973.460.399.960white0.9250825363264430.0749174636735574
515.20.370.331.20.02813.081.00.99023.370.3811.760white0.7419447751099760.258055224890024
525.20.380.267.70.05320.0103.00.99253.270.4512.260white0.7872173156410980.212782684358902
535.20.4050.151.450.03810.044.00.991253.520.411.640white0.8254248993678110.174575100632189
545.20.6450.02.150.0815.028.00.994443.780.6112.560red0.9614142369206830.0385857630793167
555.30.160.391.00.02840.0101.00.991563.570.5910.660white0.7933325279254490.206667472074551
565.30.20.313.60.03622.091.00.992783.410.59.860white0.8352790714816830.164720928518317
575.30.230.560.90.04146.0141.00.991193.160.629.750white0.7838408620008720.216159137999128
585.30.260.235.150.03448.0160.00.99523.820.5110.571white0.9277907957783920.0722092042216077
595.30.2750.247.40.03828.0114.00.993133.380.5111.060white0.8054614822580480.194538517741952
605.30.30.164.20.02937.0100.00.99053.30.3611.881white0.6710398875793310.328960112420669
615.30.30.21.10.07748.0166.00.99443.30.548.740white0.9435184821080530.056481517891947
625.30.310.3810.50.03153.0140.00.993213.340.4611.760white0.7502171566624940.249782843337506
635.30.320.126.60.04322.0141.00.99373.360.610.460white0.8628663794428350.137133620557165
645.30.330.31.20.04825.0119.00.990453.320.6211.360white0.7509073041451290.249092695854871
655.30.360.276.30.02840.0132.00.991863.370.411.660white0.7508938503404350.249106149659565
665.30.3950.071.30.03526.0102.00.9923.50.3510.660white0.8635234006971810.136476599302819
675.30.40.253.90.03145.0130.00.990723.310.5811.7571white0.7240126163019480.275987383698052
685.30.470.11.30.03611.074.00.990823.480.5411.240white0.8077337624113850.192266237588615
695.30.470.112.20.04816.089.00.991823.540.8813.671red0.8543637997122010.145636200287799
705.30.60.341.40.0313.060.00.988543.270.3813.060white0.641689933360110.35831006663989
715.30.7150.191.50.1617.062.00.993953.620.6111.050red0.96183480823550.0381651917644998
725.30.760.032.70.04327.093.00.99323.340.389.250white0.9354404520483090.0645595479516914
735.40.150.322.50.03710.051.00.988783.040.5812.660white0.4861836491464980.513816350853502
745.40.170.272.70.04928.0104.00.992243.460.5510.360white0.8094574771962260.190542522803774
755.40.180.244.80.04130.0113.00.994453.420.49.460white0.8948940657066950.105105934293305
765.40.1850.197.10.04836.0110.00.994383.260.419.560white0.8647802960671890.135219703932811
775.40.2050.1612.550.05131.0115.00.995643.40.3810.860white0.8542350107170620.145764989282939
785.40.240.182.30.0522.0145.00.992073.240.4610.350white0.8210975288857470.178902471114253
795.40.2550.331.20.05129.0122.00.990483.370.6611.360white0.7273945780913190.272605421908681
805.40.2650.287.80.05227.091.00.994323.190.3810.460white0.8633850217050250.136614978294975
815.40.290.473.00.05247.0145.00.9933.290.7510.060white0.8665659523218930.133434047678107
825.40.330.314.00.0327.0108.00.990313.30.4312.271white0.6547332703790140.345266729620986
835.40.4150.191.60.03927.088.00.992653.540.4110.071white0.8874463778508370.112553622149163
845.40.420.272.00.09223.055.00.994713.780.6412.371red0.9510868398822670.0489131601177332
855.40.450.276.40.03320.0102.00.989443.220.2713.481white0.5352476346582290.464752365341771
865.40.530.162.70.03634.0128.00.988563.20.5313.281white0.582267428715820.41773257128418
875.40.580.081.90.05920.031.00.994843.50.6410.260red0.961452230132420.0385477698675798
885.40.8350.081.20.04613.093.00.99243.570.8513.071red0.928837244421260.0711627555787398
895.50.140.274.60.02922.0104.00.99493.340.449.050white0.904433979212350.0955660207876504
905.50.150.3214.00.03116.099.00.994373.260.3811.581white0.7098762123506470.290123787649353
915.50.160.311.20.02631.068.00.98983.330.4411.6560white0.6217876071828880.378212392817112
925.50.180.225.50.03710.086.00.991563.460.4412.250white0.6857302877307940.314269712269206
935.50.230.192.20.04439.0161.00.992093.190.4310.460white0.8150221975272030.184977802472797
945.50.280.211.60.03223.085.00.990273.420.4212.550white0.6949829456415760.305017054358424
955.50.290.31.10.02220.0110.00.988693.340.3812.871white0.5493214744125850.450678525587415
965.50.30.251.90.02933.0118.00.989723.360.6612.560white0.6386226927888870.361377307211113
975.50.320.131.30.03745.0156.00.991843.260.3810.750white0.8317118889282080.168288111071792
985.50.350.351.10.04514.0167.00.9923.340.689.960white0.8475237705540650.152476229445935
995.50.620.331.70.03724.0118.00.987583.150.3913.5560white0.5233137333304070.476686266669593
1005.60.120.332.90.04421.073.00.988963.170.3212.981white0.4663016115557620.533698388444238
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.