Loading...

verticapy.machine_learning.vertica.ensemble.RandomForestRegressor

class verticapy.machine_learning.vertica.ensemble.RandomForestRegressor(name: str = None, overwrite_model: bool = False, n_estimators: int = 10, max_features: Literal['auto', 'max'] | int = 'auto', max_leaf_nodes: Annotated[int | float | Decimal, 'Python Numbers'] = 1000000000.0, sample: float = 0.632, max_depth: int = 5, min_samples_leaf: int = 1, min_info_gain: Annotated[int | float | Decimal, 'Python Numbers'] = 0.0, nbins: int = 32)

Creates a RandomForestRegressor object using the Vertica RF_REGRESSOR function. It is an ensemble learning method for regression that operates by constructing a multitude of decision trees at training-time and outputting a class with the mode.

Parameters

name: str, optional

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

overwrite_model: bool, optional

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

n_estimators: int, optional

The number of trees in the forest, an integer between 1 and 1000, inclusive.

max_features: int | str, optional

The number of randomly chosen features from which to pick the best feature to split 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 integerv between ``1 and 1e9, inclusive.

sample: float, optional

The portion of the input data set that is randomly selected for training each tree, a float between 0.0 and 1.0, inclusive.

max_depth: int, optional

aximum depth of each tree, an integer between 1 and 100, inclusive.

min_samples_leaf: int, optional

The minimum number of samples each branch must have after splitting a node, an integer between 1 and 1e6, inclusive. A split that results in remaining samples less than this value 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

Number of bins used to find splits in each column, where more splits leads to a longer runtime but more fine-grained, possibly better splits. Must be an integer between 2 and 1000, inclusive.

Attributes

Many attributes are created during the fitting phase.

trees_: list of BinaryTreeRegressor

Tree models are instances of ` BinaryTreeRegressor, each possessing various attributes. For more detailed information, refer to the documentation for BinaryTreeRegressor.

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.

features_importance_trees_: dict of numpy.array

Each element of the array represents the feature importance of tree i. The importance of features is calculated using the MDI (Mean Decreased Impurity). It is necessary to use the features_importance() method to compute it initially, and the computed values will be subsequently utilized for subsequent calls.

n_estimators_: int

The number of model estimators.

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.

Model Initialization

First we import the RandomForestRegressor model:

from verticapy.machine_learning.vertica import RandomForestRegressor

Then we can create the model:

model = RandomForestRegressor(
    max_features = "auto",
    max_leaf_nodes = 32,
    sample = 0.5,
    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",
    ],
    "quality",
    test,
)



===========
call_string
===========
SELECT rf_regressor('"public"."_verticapy_tmp_randomforestregressor_v_mldb_463d98f4979811efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_466ba51e979811efa8720242ac120002_"', 'quality', '"fixed_acidity", "volatile_acidity", "citric_acid", "residual_sugar", "chlorides", "density"' USING PARAMETERS exclude_columns='', ntree=10, mtry=3, sampling_size=0.5, 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    | 10  
rejected_row_count|  0  
accepted_row_count|5199 

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
explained_variance0.177671305427858
max_error3.48732126843369
median_absolute_error0.523595651178165
mean_absolute_error0.624306886536957
mean_squared_error0.613954715094571
root_mean_squared_error0.78355262433009
r20.177352751392407
r2_adj0.17352944892018
aic-619.045880801741
bic-583.028612218568
Rows: 1-10 | 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 = ["mse", "r2"]).

You can utilize the score() function to calculate various regression metrics, with the R-squared being the default.

model.score()
Out[4]: 0.177352751392407

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)
123
prediction
Float(22)
14.40.540.095.10.03852.097.00.990223.410.412.271white6.51441254699719
24.70.670.091.00.025.09.00.987223.30.3413.650white6.32814432680877
35.00.270.324.50.03258.0178.00.989563.450.3112.671white6.5981092271823
45.00.550.148.30.03235.0164.00.99183.530.5112.581white6.32772823883528
55.10.350.266.80.03436.0120.00.991883.380.411.560white6.51577648698276
65.10.350.266.80.03436.0120.00.991883.380.411.560white6.51577648698276
75.20.6450.02.150.0815.028.00.994443.780.6112.560red5.42389897018353
85.30.20.313.60.03622.091.00.992783.410.59.860white5.99314353314607
95.40.50.135.00.02812.0107.00.990793.480.8813.571white6.48362458824858
105.40.590.077.00.04536.0147.00.99443.340.579.760white5.42389897018353
115.50.160.261.50.03235.0100.00.990763.430.7712.060white6.20135149054618
125.60.180.310.20.02828.0131.00.99543.490.4210.871white5.90789982997621
135.60.190.261.40.0312.076.00.99053.250.3710.971white6.20135149054618
145.60.190.270.90.0452.0103.00.990263.50.3911.250white6.41657502290236
155.60.50.092.30.04917.099.00.99373.630.6313.050red5.50389897018353
165.60.6050.052.40.07319.025.00.992583.560.5512.950red5.49695788274742
175.70.2450.331.10.04928.0150.00.99273.130.429.350white5.82670422945635
185.70.2550.651.20.07917.0137.00.993073.20.429.450white5.80414808466225
195.70.310.297.30.0533.0143.00.993323.310.511.066666666666760white5.82670422945635
205.70.360.216.70.03851.0166.00.99413.290.6310.060white5.45944453515454
215.80.190.494.90.0444.0118.00.99353.340.389.571white5.97058738835197
225.80.270.263.50.07126.069.00.989943.10.3811.560white6.48103923181336
235.80.280.272.60.05430.0156.00.99143.530.4212.450white6.13716146321643
245.80.280.344.00.03140.099.00.98963.390.3912.871white6.5981092271823
255.80.30.121.60.03657.0163.00.992393.380.5910.560white5.60434046154874
265.80.330.216.050.04726.0166.00.99763.090.468.950white5.43422806144518
275.80.340.167.00.03726.0116.00.99493.460.4510.071white5.45944453515454
285.80.3450.1510.80.03326.0120.00.994943.250.4910.060white5.47640434882184
295.80.360.263.30.03840.0153.00.99113.340.5511.360white6.51577648698276
305.80.380.261.10.05820.0140.00.992713.270.439.760white5.53250344771844
315.80.5550.264.50.05317.0126.00.99433.240.469.150white5.42389897018353
325.90.20.231.50.03738.093.00.990213.360.4912.060white6.41657502290236
335.90.230.288.60.04637.0142.00.994323.230.5310.660white5.78819917194081
345.90.240.281.30.03236.095.00.988893.080.6412.971white6.41657502290236
355.90.270.2911.40.03631.0115.00.99493.350.4810.581white5.8051589856081
365.90.290.2513.40.06772.0160.00.997213.330.5410.360red5.43422806144518
375.90.340.312.00.0338.0142.00.988923.40.4112.971white6.44503024145143
386.00.180.311.40.03614.075.00.990853.340.5811.181white6.20135149054618
396.00.20.323.00.03126.0118.00.991343.380.6811.271white6.48732126843369
406.00.240.341.00.03652.0184.00.990973.440.4411.4560white6.20135149054618
416.00.240.411.30.03642.0118.00.990183.040.6411.7560white6.41657502290236
426.10.240.251.60.04424.0115.00.99213.390.5910.960white5.63855309245956
436.10.240.261.70.03361.0134.00.99033.190.8111.971white6.41657502290236
446.10.280.2419.950.07432.0174.00.999223.190.449.360white5.43422806144518
456.10.310.262.20.05128.0167.00.99263.370.4710.460white5.53250344771844
466.10.340.464.70.02921.094.00.9913.290.6212.360white6.51577648698276
476.10.350.071.40.06922.0108.00.99343.230.529.250white5.53250344771844
486.10.380.143.90.0627.0113.00.993443.070.349.240white5.53250344771844
496.10.40.161.80.06911.025.00.99553.420.7410.171red5.41726824777789
506.10.410.01.60.06336.087.00.99143.270.6710.860white6.16561668176549
516.10.480.091.70.07818.030.00.994023.450.5411.260red5.39630835184664
526.20.190.294.30.04533.0126.00.996583.180.429.360white5.86588417343366
536.20.20.2515.00.0558.0120.00.997673.190.539.660white5.78173759334401
546.20.240.2512.50.05547.0134.00.997583.30.519.050white5.468440692356
556.20.240.2812.20.04954.0133.00.99523.190.3710.760white5.8051589856081
566.20.260.377.10.04754.0201.00.995233.190.489.560white5.69022662947124
576.20.290.295.60.04635.0178.00.993133.250.5110.533333333333350white5.89854124328665
586.20.340.2512.10.05933.0171.00.997693.140.568.760white5.43422806144518
596.20.370.246.10.03219.086.00.989343.040.2613.481white6.62656444573137
606.20.460.254.40.06662.0207.00.99393.250.529.850white5.39630835184664
616.20.460.292.10.07432.098.00.995783.330.629.850red5.66155820729459
626.20.510.141.90.05615.034.00.993963.480.5711.560red5.39630835184664
636.30.170.422.80.02845.0107.00.99083.270.4311.860white6.48732126843369
646.30.20.261.60.02736.0141.00.992683.530.5610.860white5.87020731111694
656.30.210.281.50.05146.0142.00.99283.230.4210.160white5.92130651931577
666.30.230.31.80.03316.091.00.99063.280.411.860white6.20135149054618
676.30.250.4411.60.04148.0195.00.99683.180.529.550white5.70718644313853
686.30.260.292.20.04335.0175.00.99183.380.4311.660white6.20135149054618
696.30.270.187.70.04845.0186.00.99623.230.479.050white5.41726824777789
706.30.270.232.90.04713.0100.00.99363.280.439.850white5.45944453515454
716.30.280.296.80.05140.0143.00.993743.430.5911.060white5.78819917194081
726.30.390.246.90.0699.0117.00.99423.150.3510.240white5.45944453515454
736.30.410.160.90.03225.098.00.992743.160.429.550white5.55689272266468
746.30.480.041.10.04630.099.00.99283.240.369.660white5.54120427824084
756.30.550.151.80.07726.035.00.993143.320.8211.660red5.46936726441054
766.30.680.013.70.10332.054.00.995863.510.6611.360red5.40157980335405
776.40.1250.361.40.04422.068.00.990143.150.511.771white6.41657502290236
786.40.150.291.80.04421.0115.00.991663.10.3810.250white6.20135149054618
796.40.150.361.80.03443.0150.00.99223.420.6911.081white5.99314353314607
806.40.180.329.60.05224.090.00.99633.350.499.460white5.88343141532857
816.40.190.3510.20.04340.0106.00.996323.160.59.760white5.88343141532857
826.40.20.156.60.04626.0113.00.994082.990.589.960white5.72531138472275
836.40.20.282.50.03224.084.00.991683.310.5511.550white6.20135149054618
846.40.230.37.10.03763.0236.00.99523.060.349.260white5.78819917194081
856.40.230.377.90.0560.0150.00.994882.860.499.360white5.76373075729317
866.40.260.2510.70.04666.0179.00.996063.170.559.960white5.468440692356
876.40.270.2910.80.02817.0118.00.993563.180.3711.260white5.89854124328665
886.40.270.324.50.2461.0174.00.99483.120.489.450white5.7046760375488
896.40.320.510.70.04757.0206.00.99683.080.69.450white5.68463029834443
906.40.40.254.20.03215.091.00.989883.260.5213.160white6.62656444573137
916.40.420.468.40.0558.0180.00.994953.180.469.760white5.71628301840912
926.40.450.071.10.0310.0131.00.99052.970.2810.850white6.22980670909524
936.40.550.269.60.02720.0104.00.99243.220.7313.160white5.54120427824084
946.50.080.331.90.02823.093.00.9913.340.712.071white6.20135149054618
956.50.170.548.50.08264.0163.00.99592.890.398.860white5.84391545686718
966.50.190.281.40.04622.090.00.990383.180.5111.771white6.20135149054618
976.50.190.341.60.02939.0116.00.989543.210.6812.560white6.41657502290236
986.50.270.194.20.0466.0114.00.99553.250.358.640white5.41726824777789
996.50.270.196.60.04598.0175.00.993643.160.3410.160white5.45944453515454
1006.50.270.410.00.03974.0227.00.995823.180.59.450white5.70718644313853
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.

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_rfreg.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="\\"density\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n0 -> 1 [label="<= 0.991973", color="#000000", fontcolor="#000000"]\n0 -> 2 [label="> 0.991973", color="#000000", fontcolor="#000000"]\n1 [label="\\"fixed_acidity\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n1 -> 3 [label="<= 7.959375", color="#000000", fontcolor="#000000"]\n1 -> 4 [label="> 7.959375", color="#000000", fontcolor="#000000"]\n2 [label="\\"density\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n2 -> 5 [label="<= 0.995215", color="#000000", fontcolor="#000000"]\n2 -> 6 [label="> 0.995215", color="#000000", fontcolor="#000000"]\n3 [label="\\"volatile_acidity\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n3 -> 7 [label="<= 0.314375", color="#000000", fontcolor="#000000"]\n3 -> 8 [label="> 0.314375", color="#000000", fontcolor="#000000"]\n4 [label="5.75", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n5 [label="\\"volatile_acidity\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n5 -> 9 [label="<= 0.408125", color="#000000", fontcolor="#000000"]\n5 -> 10 [label="> 0.408125", color="#000000", fontcolor="#000000"]\n6 [label="\\"volatile_acidity\\"", shape="box", style="filled", fillcolor="#FFFFFFDD", fontcolor="#000000", color="#000000"]\n6 -> 11 [label="<= 0.220625", color="#000000", fontcolor="#000000"]\n6 -> 12 [label="> 0.220625", color="#000000", fontcolor="#000000"]\n7 [label="6.345506", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n8 [label="6.630058", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n9 [label="5.899851", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n10 [label="5.425373", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n11 [label="6.043956", fillcolor="#FFFFFFDD", fontcolor="#000000", shape="none", color="#000000"]\n12 [label="5.478088", 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.

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[6]: '((CASE WHEN "density" < 0.991973 THEN (CASE WHEN "fixed_acidity" < 7.959375 THEN (CASE WHEN "volatile_acidity" < 0.314375 THEN 6.345506 ELSE 6.630058 END) ELSE 5.75 END) ELSE (CASE WHEN "density" < 0.995215 THEN (CASE WHEN "volatile_acidity" < 0.408125 THEN 5.899851 ELSE 5.425373 END) ELSE (CASE WHEN "volatile_acidity" < 0.220625 THEN 6.043956 ELSE 5.478088 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "residual_sugar" < 2.6375 THEN (CASE WHEN "density" < 0.990352 THEN 6.409722 ELSE 6.096234 END) ELSE (CASE WHEN "fixed_acidity" < 7.58125 THEN 6.719745 ELSE 6.166667 END) END) ELSE (CASE WHEN "density" < 0.993594 THEN (CASE WHEN "citric_acid" < 0.269062 THEN 5.562963 ELSE 6.041379 END) ELSE (CASE WHEN "residual_sugar" < 8.75 THEN 5.556405 ELSE 5.726003 END) END) END) + (CASE WHEN "density" < 0.993594 THEN (CASE WHEN "chlorides" < 0.046562 THEN (CASE WHEN "density" < 0.990352 THEN 6.558824 ELSE 6.157983 END) ELSE (CASE WHEN "density" < 0.991973 THEN 6.0625 ELSE 5.717241 END) END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN (CASE WHEN "volatile_acidity" < 0.876875 THEN 5.411348 ELSE 4.7 END) ELSE (CASE WHEN "citric_acid" < 0.3075 THEN 5.930435 ELSE 5.685751 END) END) END) + (CASE WHEN "density" < 0.993594 THEN (CASE WHEN "density" < 0.990352 THEN (CASE WHEN "chlorides" < 0.046562 THEN 6.572254 ELSE 6.166667 END) ELSE (CASE WHEN "chlorides" < 0.046562 THEN 6.143608 ELSE 5.865979 END) END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN (CASE WHEN "volatile_acidity" < 0.970625 THEN 5.447842 ELSE 4.416667 END) ELSE (CASE WHEN "chlorides" < 0.140469 THEN 5.752709 ELSE 5.162162 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "volatile_acidity" < 0.54875 THEN (CASE WHEN "fixed_acidity" < 7.58125 THEN 6.451271 ELSE 6.044776 END) ELSE 5.692308 END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN (CASE WHEN "volatile_acidity" < 0.2675 THEN 5.693431 ELSE 5.351304 END) ELSE (CASE WHEN "density" < 0.995215 THEN 5.983395 ELSE 5.670116 END) END) END) + (CASE WHEN "volatile_acidity" < 0.455 THEN (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "residual_sugar" < 2.6375 THEN 6.265416 ELSE 6.721519 END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN 5.480978 ELSE 5.855462 END) END) ELSE (CASE WHEN "fixed_acidity" < 6.06875 THEN (CASE WHEN "volatile_acidity" < 0.501875 THEN 6.4 ELSE 5.6 END) ELSE (CASE WHEN "density" < 0.990352 THEN 6.666667 ELSE 5.324094 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "chlorides" < 0.027781 THEN 6.592105 ELSE (CASE WHEN "chlorides" < 0.046562 THEN 6.336585 ELSE 6.067797 END) END) ELSE (CASE WHEN "volatile_acidity" < 0.220625 THEN 6.008639 ELSE (CASE WHEN "citric_acid" < 0.269062 THEN 5.354633 ELSE 5.684043 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "density" < 0.990352 THEN (CASE WHEN "residual_sugar" < 2.6375 THEN 6.458599 ELSE 6.836364 END) ELSE (CASE WHEN "residual_sugar" < 2.6375 THEN 6.099567 ELSE 6.557971 END) END) ELSE (CASE WHEN "volatile_acidity" < 0.220625 THEN (CASE WHEN "residual_sugar" < 6.7125 THEN 5.947598 ELSE 6.198157 END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN 5.374429 ELSE 5.701736 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "residual_sugar" < 2.6375 THEN (CASE WHEN "density" < 0.990352 THEN 6.29932 ELSE 6.017778 END) ELSE (CASE WHEN "chlorides" < 0.027781 THEN 6.511628 ELSE 6.666667 END) END) ELSE (CASE WHEN "volatile_acidity" < 0.220625 THEN 6.04878 ELSE (CASE WHEN "citric_acid" < 0.269062 THEN 5.375963 ELSE 5.673216 END) END) END) + (CASE WHEN "density" < 0.991973 THEN (CASE WHEN "residual_sugar" < 2.6375 THEN (CASE WHEN "density" < 0.990352 THEN 6.468254 ELSE 6.099567 END) ELSE (CASE WHEN "fixed_acidity" < 6.825 THEN 6.772358 ELSE 6.361702 END) END) ELSE (CASE WHEN "citric_acid" < 0.269062 THEN (CASE WHEN "volatile_acidity" < 0.220625 THEN 5.758242 ELSE 5.341693 END) ELSE (CASE WHEN "citric_acid" < 0.46125 THEN 5.84474 ELSE 5.619178 END) END) END)) / 10'

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[8]: array([6.4165751])

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, n_estimators: int = 10, max_features: Literal['auto', 'max'] | int = 'auto', max_leaf_nodes: Annotated[int | float | Decimal, 'Python Numbers'] = 1000000000.0, sample: float = 0.632, max_depth: int = 5, 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

contour([nbins, chart])

Draws the model's contour plot.

deploySQL([X])

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.

plot([max_nb_points, chart])

Draws the model.

plot_tree([tree_id, pic_path])

Draws the input tree.

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

Predicts 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'.

regression_report([metrics])

Computes a regression report

report([metrics])

Computes a regression report

score([metric])

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