Loading...

verticapy.machine_learning.vertica.tree.DecisionTreeClassifier

class verticapy.machine_learning.vertica.tree.DecisionTreeClassifier(name: str = None, overwrite_model: bool = False, max_features: Literal['auto', 'max'] | int = 'auto', max_leaf_nodes: Annotated[int | float | Decimal, 'Python Numbers'] = 1000000000.0, max_depth: int = 100, min_samples_leaf: int = 1, min_info_gain: Annotated[int | float | Decimal, 'Python Numbers'] = 0.0, nbins: int = 32)

A DecisionTreeClassifier consisting of a single tree.

Parameters

name: str, optional

Name of the model. The model is stored in the database.

overwrite_model: bool, optional

If set to True, training a model with the same name as an existing model overwrites the existing model.

max_features: str / int, optional

The number of randomly chosen features from which to pick the best feature to split on a given tree node. It can be an integer or one of the two following methods.

  • auto:

    square root of the total number of predictors.

  • max:

    number of predictors.

max_leaf_nodes: PythonNumber, optional

The maximum number of leaf nodes for a tree in the forest, an integer between 1 and 1e9, inclusive.

max_depth: int, optional

The maximum depth for growing each tree, an integer between 1 and 100, inclusive.

min_samples_leaf: int, optional

The minimum number of samples each branch must have after a node is split, an integer between 1 and 1e6, inclusive. Any split that results in fewer remaining samples is discarded.

min_info_gain: PythonNumber, optional

The minimum threshold for including a split, a float between 0.0 and 1.0, inclusive. A split with information gain less than this threshold is discarded.

nbins: int, optional

The number of bins to use for continuous features, an integer between 2 and 1000, inclusive.

Attributes

Many attributes are created during the fitting phase.

trees_: list of one BinaryTreeClassifier

One tree model which is instance of BinaryTreeClassifier. It possess various attributes. For more detailed information, refer to the documentation for BinaryTreeClassifier().

features_importance_: numpy.array

The importance of features. It is calculated using the MDI (Mean Decreased Impurity). To determine the final score, VerticaPy sums the scores of each tree, normalizes them and applies an activation function to scale them. It is necessary to use the features_importance() method to compute it initially, and the computed values will be subsequently utilized for subsequent calls.

classes_: numpy.array

The classes labels.

Note

All attributes can be accessed using the get_attributes() method.

Note

Several other attributes can be accessed by using the get_vertica_attributes() method.

Examples

The following examples provide a basic understanding of usage. For more detailed examples, please refer to the Machine Learning or the Examples section on the website.

Important

Many tree-based models inherit from the RandomForest base class, and it’s recommended to use it directly for access to a wider range of options.

Load data for machine learning

We import verticapy:

import verticapy as vp

Hint

By assigning an alias to verticapy, we mitigate the risk of code collisions with other libraries. This precaution is necessary because verticapy uses commonly known function names like “average” and “median”, which can potentially lead to naming conflicts. The use of an alias ensures that the functions from verticapy are used as intended without interfering with functions from other libraries.

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

Note

VerticaPy offers a wide range of sample datasets that are ideal for training and testing purposes. You can explore the full list of available datasets in the Datasets, which provides detailed information on each dataset and how to use them effectively. These datasets are invaluable resources for honing your data analysis and machine learning skills within the VerticaPy environment.

You can easily divide your dataset into training and testing subsets using the vDataFrame.train_test_split() method. This is a crucial step when preparing your data for machine learning, as it allows you to evaluate the performance of your models accurately.

data = vpd.load_winequality()
train, test = data.train_test_split(test_size = 0.2)

Warning

In this case, VerticaPy utilizes seeded randomization to guarantee the reproducibility of your data split. However, please be aware that this approach may lead to reduced performance. For a more efficient data split, you can use the vDataFrame.to_db() method to save your results into tables or temporary tables. This will help enhance the overall performance of the process.

Balancing the Dataset

In VerticaPy, balancing a dataset to address class imbalances is made straightforward through the balance() function within the preprocessing module. This function enables users to rectify skewed class distributions efficiently. By specifying the target variable and setting parameters like the method for balancing, users can effortlessly achieve a more equitable representation of classes in their dataset. Whether opting for over-sampling, under-sampling, or a combination of both, VerticaPy’s balance() function streamlines the process, empowering users to enhance the performance and fairness of their machine learning models trained on imbalanced data.

To balance the dataset, use the following syntax.

from verticapy.machine_learning.vertica.preprocessing import balance

balanced_train = balance(
    name = "my_schema.train_balanced",
    input_relation = train,
    y = "good",
    method = "hybrid",
)

Note

With this code, a table named train_balanced is created in the my_schema schema. It can then be used to train the model. In the rest of the example, we will work with the full dataset.

Hint

Balancing the dataset is a crucial step in improving the accuracy of machine learning models, particularly when faced with imbalanced class distributions. By addressing disparities in the number of instances across different classes, the model becomes more adept at learning patterns from all classes rather than being biased towards the majority class. This, in turn, enhances the model’s ability to make accurate predictions for under-represented classes. The balanced dataset ensures that the model is not dominated by the majority class and, as a result, leads to more robust and unbiased model performance. Therefore, by employing techniques such as over-sampling, under-sampling, or a combination of both during dataset preparation, practitioners can significantly contribute to achieving higher accuracy and better generalization of their machine learning models.

Model Initialization

First we import the DecisionTreeClassifier model:

from verticapy.machine_learning.vertica import DecisionTreeClassifier

Then we can create the model:

model = DecisionTreeClassifier(
    max_features = "auto",
    max_leaf_nodes = 32,
    max_depth = 3,
    min_samples_leaf = 5,
    min_info_gain = 0.0,
    nbins = 32,
)

Hint

In verticapy 1.0.x and higher, you do not need to specify the model name, as the name is automatically assigned. If you need to re-use the model, you can fetch the model name from the model’s attributes.

Important

The model name is crucial for the model management system and versioning. It’s highly recommended to provide a name if you plan to reuse the model later.

Model Training

We can now fit the model:

model.fit(
    train,
    [
        "fixed_acidity",
        "volatile_acidity",
        "citric_acid",
        "residual_sugar",
        "chlorides",
        "density"
    ],
    "good",
    test,
)



===========
call_string
===========
SELECT rf_classifier('"public"."_verticapy_tmp_randomforestclassifier_v_mldb_566ab6b8979c11efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_569984ac979c11efa8720242ac120002_"', 'good', '"fixed_acidity", "volatile_acidity", "citric_acid", "residual_sugar", "chlorides", "density"' USING PARAMETERS exclude_columns='', ntree=1, mtry=3, sampling_size=1, max_depth=3, max_breadth=32, min_leaf_size=5, min_info_gain=0, nbins=32);

=======
details
=======
   predictor    |      type      
----------------+----------------
 fixed_acidity  |float or numeric
volatile_acidity|float or numeric
  citric_acid   |float or numeric
 residual_sugar |float or numeric
   chlorides    |float or numeric
    density     |float or numeric


===============
Additional Info
===============
       Name       |Value
------------------+-----
    tree_count    |  1  
rejected_row_count|  0  
accepted_row_count|5194 

Important

To train a model, you can directly use the vDataFrame or the name of the relation stored in the database. The test set is optional and is only used to compute the test metrics. In verticapy, we don’t work using X matrices and y vectors. Instead, we work directly with lists of predictors and the response name.

Features Importance

We can conveniently get the features importance:

result = model.features_importance()

Note

In models such as RandomForest, feature importance is calculated using the MDI (Mean Decreased Impurity). To determine the final score, VerticaPy sums the scores of each tree, normalizes them and applies an activation function to scale them.

Metrics

We can get the entire report using:

model.report()
value
auc0.7415734989648035
prc_auc0.4117284620513243
accuracy0.8066001534919417
log_loss0.186166875398692
precision0.5333333333333333
recall0.03162055335968379
f1_score0.059701492537313425
mcc0.09253148836995512
informedness0.024953886693017013
markedness0.34311594202898554
csi0.03076923076923077
Rows: 1-11 | Columns: 2

Important

Most metrics are computed using a single SQL query, but some of them might require multiple SQL queries. Selecting only the necessary metrics in the report can help optimize performance. E.g. model.report(metrics = ["auc", "accuracy"]).

For classification models, we can easily modify the cutoff to observe the effect on different metrics:

model.report(cutoff = 0.2)
value
auc0.7415734989648035
prc_auc0.4117284620513243
accuracy0.6999232540291634
log_loss0.186166875398692
precision0.35802469135802467
recall0.6877470355731226
f1_score0.4709066305818673
mcc0.3194939450828974
informedness0.3906041784302654
markedness0.2613294649198361
csi0.30796460176991153
Rows: 1-11 | Columns: 2

You can also use the score() function to compute any classification metric. The default metric is the accuracy:

model.score()
Out[3]: 0.8066001534919417

Prediction

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)
Abc
prediction
Varchar(1)
14.70.60.172.30.05817.0106.00.99323.850.612.960red0
25.00.270.324.50.03258.0178.00.989563.450.3112.671white0
35.00.290.545.70.03554.0155.00.989763.270.3412.981white0
45.00.610.121.30.00965.0100.00.98743.260.3713.550white0
55.10.210.281.40.04748.0148.00.991683.50.4910.450white0
65.10.350.266.80.03436.0120.00.991883.380.411.560white0
75.10.470.021.30.03418.044.00.99213.90.6212.860red0
85.20.60.077.00.04433.0147.00.99443.330.589.750white0
95.20.6450.02.150.0815.028.00.994443.780.6112.560red0
105.30.240.331.30.03325.097.00.99063.590.3811.081white0
115.40.2550.331.20.05129.0122.00.990483.370.6611.360white0
125.50.240.328.70.0619.0102.00.9943.270.3110.450white0
135.60.180.311.50.03816.084.00.99243.340.5810.160white0
145.60.2250.249.80.05459.0140.00.995453.170.3910.260white0
155.60.280.273.90.04352.0158.00.992023.350.4410.771white0
165.60.310.371.40.07412.096.00.99543.320.589.250red0
175.60.6950.066.80.0429.084.00.994323.440.4410.250white0
185.70.220.2216.650.04439.0110.00.998553.240.489.060white0
195.70.310.297.30.0533.0143.00.993323.310.511.066666666666760white0
205.70.320.52.60.04917.0155.00.99273.220.6410.060white0
215.70.330.151.90.0520.093.00.99343.380.629.950white0
225.70.450.421.10.05161.0197.00.99323.020.49.050white0
235.80.20.241.40.03365.0169.00.990433.590.5612.371white0
245.80.280.272.60.05430.0156.00.99143.530.4212.450white0
255.80.30.121.60.03657.0163.00.992393.380.5910.560white0
265.80.360.51.00.12763.0178.00.992123.10.459.750white0
275.90.170.280.70.0275.028.00.989853.130.3210.650white0
285.90.170.293.10.0332.0123.00.989133.410.3313.771white0
295.90.230.288.60.04637.0142.00.994323.230.5310.660white0
305.90.240.32.00.03328.092.00.992253.390.6910.971white0
315.90.240.32.00.03328.092.00.992253.390.6910.971white0
325.90.250.271.50.02937.081.00.98923.20.4612.260white0
335.90.4150.131.40.0411.064.00.99223.290.5210.550white0
346.00.260.151.20.05335.0124.00.993473.080.468.850white0
356.00.260.187.00.05550.0194.00.995913.210.439.050white0
366.00.280.274.10.04650.0147.00.991263.270.5611.660white0
376.00.280.526.20.02837.0104.00.991613.280.5111.871white0
386.00.340.6615.90.04626.0164.00.99793.140.58.860white0
396.00.380.266.00.03442.0134.00.99123.380.3812.371white0
406.00.420.4112.40.03250.0179.00.996223.140.69.750white0
416.00.490.02.30.06815.033.00.992923.580.5912.560red0
426.10.160.2712.60.06463.0162.00.99943.660.438.950white0
436.10.220.382.80.14412.065.00.99082.950.6411.460white0
446.10.260.512.20.0561.0154.00.99293.080.69.860white0
456.10.280.2419.950.07432.0174.00.999223.190.449.360white0
466.10.340.464.70.02921.094.00.9913.290.6212.360white0
476.10.40.161.80.06911.025.00.99553.420.7410.171red0
486.20.160.331.10.05721.082.00.9913.320.4610.971white0
496.20.190.385.10.01922.082.00.989613.050.3612.560white0
506.20.20.2515.00.0558.0120.00.997673.190.539.660white0
516.20.20.281.10.03924.078.00.98993.360.4712.160white0
526.20.20.335.40.02821.075.00.990123.360.4113.571white0
536.20.220.282.20.0424.0125.00.99173.190.4810.560white0
546.20.220.282.20.0424.0125.00.99173.190.4810.560white0
556.20.250.4415.80.05739.0167.00.998043.140.519.250white0
566.20.290.295.60.04635.0178.00.993133.250.5110.533333333333350white0
576.20.30.211.10.03231.0111.00.98892.970.4212.260white0
586.20.30.311.20.04819.0125.00.989993.320.5412.660white0
596.20.30.321.70.03230.0130.00.99113.280.4111.271white0
606.20.310.264.80.03736.0148.00.99283.210.4110.460white0
616.20.320.56.50.04861.0186.00.99483.190.459.650white0
626.20.360.225.250.03844.0145.00.991843.220.411.260white0
636.20.370.246.10.03219.086.00.989343.040.2613.481white1
646.20.530.020.90.0356.081.00.992343.240.359.540white0
656.20.560.091.70.05324.032.00.994023.540.611.350red0
666.20.630.311.70.08815.064.00.99693.460.799.350red0
676.30.20.261.60.02736.0141.00.992683.530.5610.860white0
686.30.220.32.00.0523.0120.00.992043.240.4710.460white0
696.30.220.331.70.04167.0164.00.99283.320.5610.460white0
706.30.230.497.10.0567.0210.00.99513.230.349.550white0
716.30.250.2314.90.03947.0142.00.997053.140.359.760white0
726.30.270.187.70.04845.0186.00.99623.230.479.050white0
736.30.270.4611.750.03761.0212.00.99713.250.539.560white0
746.30.280.296.80.05140.0143.00.993743.430.5911.060white0
756.30.290.284.70.05928.081.00.990363.240.5612.781white0
766.30.320.3511.10.03929.0198.00.99843.360.59.471white0
776.30.410.183.50.02723.0109.00.990183.340.5412.881white1
786.30.410.33.20.0349.0164.00.99273.530.7911.771white0
796.30.480.041.10.04630.099.00.99283.240.369.660white0
806.40.140.311.20.03453.0138.00.990843.380.3511.571white0
816.40.220.3113.90.0457.0135.00.996723.210.3810.750white0
826.40.250.320.90.03440.0114.00.991143.310.5810.871white0
836.40.270.2910.80.02817.0118.00.993563.180.3711.260white0
846.40.270.324.50.2461.0174.00.99483.120.489.450white0
856.40.310.281.50.03712.0119.00.99193.320.5110.471white0
866.40.410.016.10.04820.070.00.993623.190.4210.050white0
876.50.180.4818.00.05456.0183.01.000382.980.618.560white0
886.50.210.355.70.04347.0197.00.993923.240.510.160white0
896.50.220.297.40.02816.087.00.993113.150.5610.971white0
906.50.230.3616.30.03843.0133.00.999243.260.418.850white0
916.50.230.3616.30.03843.0133.00.999243.260.418.850white0
926.50.240.3917.30.05222.0126.00.998883.110.479.260white0
936.50.250.329.90.04541.0128.00.996363.180.529.660white0
946.50.280.288.50.04754.0210.00.99623.090.548.940white0
956.50.320.231.20.05439.0208.00.992723.180.469.960white0
966.50.360.3810.20.02820.082.00.992743.10.4312.171white0
976.50.40.313.50.04622.0147.00.990243.150.3112.071white0
986.50.520.111.80.07313.038.00.99553.340.529.350red0
996.50.520.171.40.0475.026.00.99323.260.3210.040white0
1006.60.210.291.80.02635.0128.00.991833.370.4811.260white0
Rows: 1-100 | Columns: 15

Note

Predictions can be made automatically using the test set, in which case you don’t need to specify the predictors. Alternatively, you can pass only the vDataFrame to the predict() function, but in this case, it’s essential that the column names of the vDataFrame match the predictors and response name in the model.

Probabilities

It is also easy to get the model’s probabilities:

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)
Abc
prediction
Varchar(1)
Abc
prediction_0
Varchar(128)
Abc
prediction_1
Varchar(128)
14.20.2150.235.10.04164.0157.00.996883.420.448.030white00.9446640.055336
24.60.4450.01.40.05311.0178.00.994263.790.5510.250white00.9446640.055336
34.80.130.321.20.04240.098.00.98983.420.6411.871white00.5669460.433054
44.90.3350.141.30.03669.0168.00.992123.470.4610.466666666666750white00.9446640.055336
55.00.740.01.20.04116.046.00.992584.010.5912.560red00.9446640.055336
65.10.420.011.50.01725.0102.00.98943.380.3612.371white00.7446810.255319
75.20.30.341.50.03818.096.00.989423.560.4813.081white00.5669460.433054
85.20.380.267.70.05320.0103.00.99253.270.4512.260white00.8631310.136869
95.40.220.356.50.02926.087.00.990923.290.4412.571white00.5669460.433054
105.60.130.274.80.02822.0104.00.99483.340.459.260white00.7476640.252336
115.60.240.342.00.04114.073.00.989813.040.4511.671white00.5669460.433054
125.60.320.337.40.03725.095.00.992683.250.4911.160white00.8631310.136869
135.60.350.46.30.02223.0174.00.99223.540.511.671white00.8631310.136869
145.60.540.041.70.0495.013.00.99423.720.5811.450red00.9446640.055336
155.70.120.265.50.03421.099.00.993243.090.579.960white00.7476640.252336
165.70.260.2510.40.027.057.00.9943.390.3710.650white00.7837840.216216
175.70.2650.286.90.03646.0150.00.992993.360.4410.871white00.8631310.136869
185.70.310.284.10.0322.086.00.990623.310.3811.771white00.5669460.433054
195.70.40.355.10.02617.0113.00.990523.180.6712.460white00.5669460.433054
205.80.120.211.30.05635.0121.00.99083.320.3311.460white00.7446810.255319
215.80.130.2212.70.05824.0183.00.99563.320.4211.760white00.9446640.055336
225.80.150.491.10.04821.098.00.99293.190.489.250white00.7476640.252336
235.80.230.22.00.04339.0154.00.992263.210.3910.260white00.9446640.055336
245.80.240.2610.050.03963.0162.00.993753.330.511.260white00.8631310.136869
255.80.270.214.950.04422.0179.00.99623.370.3710.250white00.9446640.055336
265.80.270.41.20.07647.0130.00.991853.130.4510.360white00.8833330.116667
275.80.280.352.30.05336.0114.00.99243.280.510.240white00.8631310.136869
285.90.270.322.00.03431.0102.00.989523.160.5612.360white00.5669460.433054
295.90.280.391.40.03147.0147.00.988363.080.6412.971white00.5669460.433054
305.90.290.167.90.04448.0197.00.995123.210.369.450white00.9446640.055336
315.90.320.214.40.0529.0144.00.996663.240.4110.360white00.9446640.055336
325.90.320.393.30.11424.0140.00.99343.090.459.260white00.8631310.136869
336.00.170.361.70.04214.061.00.991443.220.5410.860white00.5669460.433054
346.00.190.379.70.03217.050.00.99323.080.6612.060white00.7476640.252336
356.00.220.281.10.03447.090.00.988623.220.3812.660white00.5669460.433054
366.00.230.341.30.02523.0111.00.989613.360.3712.760white00.5669460.433054
376.00.270.271.60.04632.0113.00.99243.410.5110.571white00.8631310.136869
386.00.290.251.40.03330.0114.00.987943.080.4313.260white00.7446810.255319
396.00.290.272.30.04420.0117.00.98953.310.4112.771white00.5669460.433054
406.00.290.4110.80.04855.0149.00.99373.090.5910.966666666666771white00.8631310.136869
416.00.290.4110.80.04855.0149.00.99373.090.5910.966666666666771white00.8631310.136869
426.00.310.327.40.17547.0159.00.99523.190.59.460white00.8631310.136869
436.00.310.473.60.06718.042.00.995493.390.6611.060red00.8631310.136869
446.00.330.3212.90.0546.0113.00.995723.30.5611.540red00.8631310.136869
456.00.350.460.90.0339.065.00.989343.240.3512.140white00.5669460.433054
466.00.50.01.40.05715.026.00.994483.360.459.550red00.9446640.055336
476.00.640.051.90.0669.017.00.994963.520.7810.650red00.9446640.055336
486.10.160.346.10.03431.0114.00.993653.320.5810.133333333333371white00.7476640.252336
496.10.20.171.60.04846.0129.00.9913.30.4311.460white10.470.53
506.10.250.4815.80.05225.094.00.997823.070.459.260white00.8631310.136869
516.10.270.446.70.04161.0230.00.995053.120.48.950white00.8631310.136869
526.10.310.342.80.04259.5162.00.991793.270.4710.860white00.5669460.433054
536.10.320.252.30.07123.058.00.996333.420.9710.650red00.9446640.055336
546.10.320.3310.70.03627.098.00.995213.340.5210.260white00.8631310.136869
556.20.180.494.50.04717.090.00.99193.270.3711.660white00.5669460.433054
566.20.20.261.10.04742.0119.00.991583.480.611.071white00.5669460.433054
576.20.250.313.20.0332.0150.00.990143.180.3112.060white00.5669460.433054
586.20.250.547.00.04658.0176.00.994543.190.710.450white00.8631310.136869
596.20.450.737.20.09947.0202.00.995823.210.439.250white00.8631310.136869
606.20.470.211.00.04413.098.00.993453.140.469.250white00.9446640.055336
616.20.550.4512.00.04927.0186.00.99743.170.59.360white00.8631310.136869
626.30.190.292.00.02233.096.00.989023.040.5412.871white00.5669460.433054
636.30.190.3310.10.06363.0133.00.995612.860.419.150white00.7476640.252336
646.30.20.264.70.04108.0168.00.992783.070.7510.771white00.7476640.252336
656.30.210.5810.00.08134.0126.00.99622.950.468.950white00.7476640.252336
666.30.240.2913.70.03553.0134.00.995673.170.3810.660white00.8631310.136869
676.30.240.352.30.03943.0109.00.990563.340.4411.860white00.5669460.433054
686.30.250.223.30.04841.0161.00.992563.160.510.560white00.9446640.055336
696.30.270.380.90.0517.0140.00.99263.450.510.571white00.8631310.136869
706.30.270.517.60.04935.0200.00.995483.160.549.440white00.8631310.136869
716.30.270.517.60.04935.0200.00.995483.160.549.440white00.8631310.136869
726.30.30.487.40.05334.0149.00.994723.180.539.850white00.8631310.136869
736.30.320.1717.750.0651.0190.00.999163.130.488.860white00.9446640.055336
746.30.320.321.50.0324.0101.00.989233.210.4213.050white00.5669460.433054
756.30.340.334.60.03419.080.00.99173.380.5812.071white00.5669460.433054
766.30.40.245.10.03643.0131.00.991863.240.4411.360white00.9446640.055336
776.30.60.4411.00.0550.0245.00.99723.190.579.340white00.8631310.136869
786.40.1050.291.10.03544.0140.00.991423.170.5510.771white00.5669460.433054
796.40.1250.295.850.04224.099.00.9923.230.3212.071white00.5669460.433054
806.40.170.322.40.04841.0200.00.99383.50.59.760white00.7476640.252336
816.40.230.272.10.04235.0100.00.990943.030.6310.960white00.5669460.433054
826.40.240.268.20.05447.0182.00.995383.120.59.550white00.8631310.136869
836.40.240.495.80.05325.0120.00.99423.010.9810.560white00.8631310.136869
846.40.240.495.80.05325.0120.00.99423.010.9810.560white00.8631310.136869
856.40.250.3211.30.03869.0192.00.995733.140.510.260white00.8631310.136869
866.40.270.497.30.04653.0206.00.99563.240.439.260white00.8631310.136869
876.40.290.1815.00.0421.0116.00.997363.140.59.250white00.9446640.055336
886.40.330.448.90.05552.0164.00.994883.10.489.650white00.8631310.136869
896.40.380.247.20.04741.0151.00.996043.110.69.250white00.9446640.055336
906.40.380.247.20.04741.0151.00.996043.110.69.250white00.9446640.055336
916.40.50.22.40.05919.0112.00.993143.180.49.260white00.9446640.055336
926.50.160.334.80.04345.0114.00.9923.180.4411.260white00.5669460.433054
936.50.180.341.60.0443.0148.00.99123.320.5911.581white00.5669460.433054
946.50.220.322.20.02836.092.00.990763.270.5911.971white00.5669460.433054
956.50.230.27.50.0544.0179.00.995043.180.489.5333333333333350white00.9446640.055336
966.50.240.381.00.02731.090.00.989263.240.3612.360white00.5669460.433054
976.50.280.344.60.05422.0130.00.991933.20.4612.071white00.8833330.116667
986.50.340.281.80.04143.0188.00.99283.130.379.660white00.8631310.136869
996.50.350.2812.40.05186.0213.00.99623.160.519.960white00.8631310.136869
1006.50.370.333.50.03623.092.00.991363.180.3811.260white00.5669460.433054
Rows: 1-100 | Columns: 17

Note

Probabilities are added to the vDataFrame, and VerticaPy uses the corresponding probability function in SQL behind the scenes. You can use the pos_label parameter to add only the probability of the selected category.

Confusion Matrix

You can obtain the confusion matrix of your choice by specifying the desired cutoff.

model.confusion_matrix(cutoff = 0.5)
Out[4]: 
array([[1043,    7],
       [ 245,    8]])

Note

In classification, the cutoff is a threshold value used to determine class assignment based on predicted probabilities or scores from a classification model. In binary classification, if the predicted probability for a specific class is greater than or equal to the cutoff, the instance is assigned to the positive class; otherwise, it is assigned to the negative class. Adjusting the cutoff allows for trade-offs between true positives and false positives, enabling the model to be optimized for specific objectives or to consider the relative costs of different classification errors. The choice of cutoff is critical for tailoring the model’s performance to meet specific needs.

Main Plots (Classification Curves)

Classification models allow for the creation of various plots that are very helpful in understanding the model, such as the ROC Curve, PRC Curve, Cutoff Curve, Gain Curve, and more.

Most of the classification curves can be found in the Machine Learning - Classification Curve.

For example, let’s draw the model’s ROC curve.

model.roc_curve()

Important

Most of the curves have a parameter called nbins, which is essential for estimating metrics. The larger the nbins, the more precise the estimation, but it can significantly impact performance. Exercise caution when increasing this parameter excessively.

Hint

In binary classification, various curves can be easily plotted. However, in multi-class classification, it’s important to select the pos_label, representing the class to be treated as positive when drawing the curve.

Other Plots

Tree models can be visualized by drawing their tree plots. For more examples, check out Machine Learning - Tree Plots.

model.plot_tree()
../_images/machine_learning_vertica_tree_decision_classifier.png

Note

The above example may not render properly in the doc because of the huge size of the tree. But it should render nicely in jupyter environment.

In order to plot graph using graphviz separately, you can extract the graphviz DOT file code as follows:

model.to_graphviz()
Out[5]: 'digraph Tree {\ngraph [bgcolor="#FFFFFFDD"];\n0 [label="\\"citric_acid\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n0 -> 1 [label="<= 0.259375", color="#000000", fontcolor="#000000"]\n0 -> 2 [label="> 0.259375", color="#000000", fontcolor="#000000"]\n1 [label="\\"density\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n1 -> 3 [label="<= 0.991474", color="#000000", fontcolor="#000000"]\n1 -> 4 [label="> 0.991474", color="#000000", fontcolor="#000000"]\n2 [label="\\"density\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n2 -> 5 [label="<= 0.992198", color="#000000", fontcolor="#000000"]\n2 -> 6 [label="> 0.992198", color="#000000", fontcolor="#000000"]\n3 [label="\\"residual_sugar\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n3 -> 7 [label="<= 1.56875", color="#000000", fontcolor="#000000"]\n3 -> 8 [label="> 1.56875", color="#000000", fontcolor="#000000"]\n4 [label="\\"chlorides\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n4 -> 9 [label="<= 0.031688", color="#000000", fontcolor="#000000"]\n4 -> 10 [label="> 0.031688", color="#000000", fontcolor="#000000"]\n5 [label="\\"chlorides\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n5 -> 11 [label="<= 0.050375", color="#000000", fontcolor="#000000"]\n5 -> 12 [label="> 0.050375", color="#000000", fontcolor="#000000"]\n6 [label="\\"volatile_acidity\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n6 -> 13 [label="<= 0.220625", color="#000000", fontcolor="#000000"]\n6 -> 14 [label="> 0.220625", color="#000000", fontcolor="#000000"]\n7 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.74</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.26</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n8 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5" color="#000000"><FONT color="#000000"><b>prediction: 1 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.47</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.53</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n9 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.78</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.22</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n10 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.94</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.06</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n11 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.57</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.43</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n12 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.88</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.12</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n13 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.75</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.25</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n14 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa" color="#000000"><FONT color="#000000"><b>prediction: 0 </b></FONT></td></tr><tr><td port="port0" border="1" align="left" color="#000000"><FONT color="#000000">prob(0): 0.86</FONT></td></tr><tr><td port="port1" border="1" align="left" color="#000000"><FONT color="#000000">prob(1): 0.14</FONT></td></tr></table>>, fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n}'

This string can then be copied into a DOT file which can beparsed by graphviz.

Contour plot is another useful plot that can be produced for models with two predictors.

model.contour()

Important

Machine learning models with two predictors can usually benefit from their own contour plot. This visual representation aids in exploring predictions and gaining a deeper understanding of how these models perform in different scenarios. Please refer to Contour Plot for more examples.

Parameter Modification

In order to see the parameters:

model.get_params()
Out[6]: 
{'max_features': 'auto',
 'max_leaf_nodes': 32,
 'max_depth': 3,
 'min_samples_leaf': 5,
 'min_info_gain': 0.0,
 'nbins': 32}

And to manually change some of the parameters:

model.set_params({'max_depth': 5})

Model Register

In order to register the model for tracking and versioning:

model.register("model_v1")

Please refer to /notebooks/ml/model_tracking_versioning/index.ipynb for more details on model tracking and versioning.

Model Exporting

To Memmodel

model.to_memmodel()

Note

MemModel objects serve as in-memory representations of machine learning models. They can be used for both in-database and in-memory prediction tasks. These objects can be pickled in the same way that you would pickle a scikit-learn model.

The following methods for exporting the model use MemModel, and it is recommended to use MemModel directly.

To SQL

You can get the SQL code by:

model.to_sql()
Out[8]: '(CASE WHEN "citric_acid" < 0.259375 THEN (CASE WHEN "density" < 0.991474 THEN (CASE WHEN "residual_sugar" < 1.56875 THEN 0 ELSE 1 END) ELSE (CASE WHEN "chlorides" < 0.031688 THEN 0 ELSE 0 END) END) ELSE (CASE WHEN "density" < 0.992198 THEN (CASE WHEN "chlorides" < 0.050375 THEN 0 ELSE 0 END) ELSE (CASE WHEN "volatile_acidity" < 0.220625 THEN 0 ELSE 0 END) END) END)'

To Python

To obtain the prediction function in Python syntax, use the following code:

X = [[4.2, 0.17, 0.36, 1.8, 0.029, 0.9899]]

model.to_python()(X)
Out[10]: array([0])

Hint

The to_python() method is used to retrieve predictions, probabilities, or cluster distances. For specific details on how to use this method for different model types, refer to the relevant documentation for each model.

__init__(name: str = None, overwrite_model: bool = False, max_features: Literal['auto', 'max'] | int = 'auto', max_leaf_nodes: Annotated[int | float | Decimal, 'Python Numbers'] = 1000000000.0, max_depth: int = 100, min_samples_leaf: int = 1, min_info_gain: Annotated[int | float | Decimal, 'Python Numbers'] = 0.0, nbins: int = 32) → None

Must be overridden in the child class

Methods

__init__([name, overwrite_model, ...])

Must be overridden in the child class

classification_report([metrics, cutoff, ...])

Computes a classification report using multiple model evaluation metrics (auc, accuracy, f1...).

confusion_matrix([pos_label, cutoff])

Computes the model confusion matrix.

contour([pos_label, nbins, chart])

Draws the model's contour plot.

cutoff_curve([pos_label, nbins, show, chart])

Draws the model Cutoff curve.

deploySQL([X, pos_label, cutoff, allSQL])

Returns the SQL code needed to deploy the model.

does_model_exists(name[, raise_error, ...])

Checks whether the model is stored in the Vertica database.

drop()

Drops the model from the Vertica database.

export_models(name, path[, kind])

Exports machine learning models.

features_importance([tree_id, show, chart])

Computes the model's features importance.

fit(input_relation, X, y[, test_relation, ...])

Trains the model.

get_attributes([attr_name])

Returns the model attributes.

get_match_index(x, col_list[, str_check])

Returns the matching index.

get_params()

Returns the parameters of the model.

get_plotting_lib([class_name, chart, ...])

Returns the first available library (Plotly, Matplotlib, or Highcharts) to draw a specific graphic.

get_score([tree_id])

Returns the feature importance metrics for the input tree.

get_tree([tree_id])

Returns a table with all the input tree information.

get_vertica_attributes([attr_name])

Returns the model Vertica attributes.

import_models(path[, schema, kind])

Imports machine learning models.

lift_chart([pos_label, nbins, show, chart])

Draws the model Lift Chart.

plot([max_nb_points, chart])

Draws the model.

plot_tree([tree_id, pic_path])

Draws the input tree.

prc_curve([pos_label, nbins, show, chart])

Draws the model PRC curve.

predict(vdf[, X, name, cutoff, inplace])

Predicts using the input relation.

predict_proba(vdf[, X, name, pos_label, inplace])

Returns the model's probabilities using the input relation.

register(registered_name[, raise_error])

Registers the model and adds it to in-DB Model versioning environment with a status of 'under_review'.

report([metrics, cutoff, labels, nbins])

Computes a classification report using multiple model evaluation metrics (auc, accuracy, f1...).

roc_curve([pos_label, nbins, show, chart])

Draws the model ROC curve.

score([metric, average, pos_label, cutoff, ...])

Computes the model score.

set_params([parameters])

Sets the parameters of the model.

summarize()

Summarizes the model.

to_binary(path)

Exports the model to the Vertica Binary format.

to_graphviz([tree_id, classes_color, ...])

Returns the code for a Graphviz tree.

to_memmodel()

Converts the model to an InMemory object that can be used for different types of predictions.

to_pmml(path)

Exports the model to PMML.

to_python([return_proba, ...])

Returns the Python function needed for in-memory scoring without using built-in Vertica functions.

to_sql([X, return_proba, ...])

Returns the SQL code needed to deploy the model without using built-in Vertica functions.

to_tf(path)

Exports the model to the Frozen Graph format (TensorFlow).

Attributes