Feedback

×

• Feedback
• Was this page helpful?*
  • Yes
  • No
• Do you have any additional feedback?
  • Yes
  • No
• Additional Feedback

verticapy.machine_learning.vertica.cluster.BisectingKMeans

class verticapy.machine_learning.vertica.cluster.BisectingKMeans(name: str = None, overwrite_model: bool = False, n_cluster: int = 8, bisection_iterations: int = 1, split_method: Literal['size', 'sum_squares'] = 'sum_squares', min_divisible_cluster_size: int = 2, distance_method: Literal['euclidean'] = 'euclidean', init: Literal['kmeanspp', 'pseudo', 'random'] | list = 'kmeanspp', max_iter: int = 300, tol: float = 0.0001)

Creates a BisectingKMeans object using the Vertica bisecting k-means algorithm. k-means clustering is a method of vector quantization, originally from signal processing, that aims to partition n observations into k clusters. Each observation belongs to the cluster with the nearest mean (cluster centers or cluster centroid), which serves as a prototype of the cluster. This results in a partitioning of the data space into Voronoi cells. Bisecting k-means combines k-means and hierarchical clustering.

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.

n_cluster: int, optional

Number of clusters

bisection_iterations: int, optional

The number of iterations the bisecting KMeans algorithm performs for each bisection step. This corresponds to how many times a standalone KMeans algorithm runs in each bisection step. Setting to a value greater than 1 allows the algorithm to run and choose the best KMeans run within each bisection step. If you are using kmeanspp, the bisection_iterations value is always 1 because kmeanspp is more costly to run but also better than the alternatives, so it does not require multiple runs.

split_method: str, optional

The method used to choose a cluster to bisect/split.

• size:

  Choose the largest cluster to bisect.

• sum_squares:

  Choose the cluster with the largest withInSS to bisect.

min_divisible_cluster_size: int, optional

The minimum number of points of a divisible cluster. Must be greater than or equal to 2.

distance_method: str, optional

The distance measure between two data points. Only Euclidean distance is supported at this time.

init: str | list, optional

The method used to find the initial KMeans cluster centers.

• kmeanspp:

  Uses the KMeans++ method to initialize the centers.

• pseudo:

  Uses “pseudo center” approach used by Spark, bisects given center without iterating over points.

You can also provide a list with the initial cluster centers.

max_iter: int, optional

The maximum number of iterations the KMeans algorithm performs.

tol: float, optional

Determines whether the KMeans algorithm has converged. The algorithm is considered converged after no center has moved more than a distance of ‘tol’ from the previous iteration.

Attributes

Many attributes are created during the fitting phase.

“children_left_”, “children_right_”,

tree_:

clusters_: numpy.array

Cluster centers.

p_: int

The p of the p-distances.

children_left_: numpy.array

A list of node IDs, where children_left[i] is the node ID of the left child of node i.

children_right_: numpy.array

A list of node IDs, where children_right[i] is the node ID of the right child of node i.

cluster_score_: numpy.array

The array containing the sizes for each cluster in a clustering analysis.

cluster_score_: numpy.array

The array containing the cluster scores for each cluster in a clustering analysis.

between_cluster_ss_: float

The between-cluster sum of squares (BSS) measures the dispersion between different clusters and is an important metric in evaluating the effectiveness of a clustering algorithm.

total_ss_: float

The total sum of squares (TSS) is used to assess the total dispersion of data points from the overall mean, providing a basis for evaluating the clustering algorithm’s performance.

total_within_cluster_ss_: float

The within-cluster sum of squares (WSS) gauges the dispersion of data points within individual clusters in a clustering analysis. It reflects the compactness of clusters and is instrumental in evaluating the homogeneity of the clusters produced by the algorithm.

elbow_score_: float

The elbow score. It helps identify the optimal number of clusters by observing the point where the rate of WSS reduction slows down, resembling the bend or ‘elbow’ in the plot, indicative of an optimal clustering solution. The bigger the better.

cluster_i_ss_: numpy.array

The array containing the sum of squares (SS) for each cluster in a clustering analysis.

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.

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)
1	3.9	0.225	0.4	4.2	0.03	29.0	118.0	0.989	3.57	0.36	12.8	8	1	white
2	4.7	0.335	0.14	1.3	0.036	69.0	168.0	0.99212	3.47	0.46	10.5	5	0	white
3	4.7	0.455	0.18	1.9	0.036	33.0	106.0	0.98746	3.21	0.83	14.0	7	1	white
4	4.7	0.785	0.0	3.4	0.036	23.0	134.0	0.98981	3.53	0.92	13.8	6	0	white
5	4.9	0.345	0.34	1.0	0.068	32.0	143.0	0.99138	3.24	0.4	10.1	5	0	white
6	4.9	0.345	0.34	1.0	0.068	32.0	143.0	0.99138	3.24	0.4	10.1	5	0	white
7	4.9	0.42	0.0	2.1	0.048	16.0	42.0	0.99154	3.71	0.74	14.0	7	1	red
8	5.0	0.27	0.4	1.2	0.076	42.0	124.0	0.99204	3.32	0.47	10.1	6	0	white
9	5.0	0.31	0.0	6.4	0.046	43.0	166.0	0.994	3.3	0.63	9.9	6	0	white
10	5.0	0.4	0.5	4.3	0.046	29.0	80.0	0.9902	3.49	0.66	13.6	6	0	red
11	5.0	0.44	0.04	18.6	0.039	38.0	128.0	0.9985	3.37	0.57	10.2	6	0	white
12	5.1	0.11	0.32	1.6	0.028	12.0	90.0	0.99008	3.57	0.52	12.2	6	0	white
13	5.1	0.14	0.25	0.7	0.039	15.0	89.0	0.9919	3.22	0.43	9.2	6	0	white
14	5.1	0.165	0.22	5.7	0.047	42.0	146.0	0.9934	3.18	0.55	9.9	6	0	white
15	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
16	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
17	5.1	0.33	0.22	1.6	0.027	18.0	89.0	0.9893	3.51	0.38	12.5	7	1	white
18	5.1	0.39	0.21	1.7	0.027	15.0	72.0	0.9894	3.5	0.45	12.5	6	0	white
19	5.2	0.2	0.27	3.2	0.047	16.0	93.0	0.99235	3.44	0.53	10.1	7	1	white
20	5.2	0.21	0.31	1.7	0.048	17.0	61.0	0.98953	3.24	0.37	12.0	7	1	white
21	5.2	0.22	0.46	6.2	0.066	41.0	187.0	0.99362	3.19	0.42	9.73333333333333	5	0	white
22	5.2	0.31	0.2	2.4	0.027	27.0	117.0	0.98886	3.56	0.45	13.0	7	1	white
23	5.2	0.32	0.25	1.8	0.103	13.0	50.0	0.9957	3.38	0.55	9.2	5	0	red
24	5.2	0.34	0.37	6.2	0.031	42.0	133.0	0.99076	3.25	0.41	12.5	6	0	white
25	5.2	0.36	0.02	1.6	0.031	24.0	104.0	0.9896	3.44	0.35	12.2	6	0	white
26	5.2	0.365	0.08	13.5	0.041	37.0	142.0	0.997	3.46	0.39	9.9	6	0	white
27	5.2	0.48	0.04	1.6	0.054	19.0	106.0	0.9927	3.54	0.62	12.2	7	1	red
28	5.2	0.5	0.18	2.0	0.036	23.0	129.0	0.98949	3.36	0.77	13.4	7	1	white
29	5.3	0.16	0.39	1.0	0.028	40.0	101.0	0.99156	3.57	0.59	10.6	6	0	white
30	5.3	0.16	0.39	1.0	0.028	40.0	101.0	0.99156	3.57	0.59	10.6	6	0	white
31	5.3	0.165	0.24	1.1	0.051	25.0	105.0	0.9925	3.32	0.47	9.1	5	0	white
32	5.3	0.23	0.56	0.9	0.041	46.0	141.0	0.99119	3.16	0.62	9.7	5	0	white
33	5.3	0.3	0.3	1.2	0.029	25.0	93.0	0.98742	3.31	0.4	13.6	7	1	white
34	5.3	0.33	0.3	1.2	0.048	25.0	119.0	0.99045	3.32	0.62	11.3	6	0	white
35	5.3	0.36	0.27	6.3	0.028	40.0	132.0	0.99186	3.37	0.4	11.6	6	0	white
36	5.3	0.36	0.27	6.3	0.028	40.0	132.0	0.99186	3.37	0.4	11.6	6	0	white
37	5.3	0.4	0.25	3.9	0.031	45.0	130.0	0.99072	3.31	0.58	11.75	7	1	white
38	5.3	0.47	0.11	2.2	0.048	16.0	89.0	0.99182	3.54	0.88	13.6	7	1	red
39	5.3	0.47	0.11	2.2	0.048	16.0	89.0	0.99182	3.54	0.88	13.5666666666667	7	1	red
40	5.3	0.715	0.19	1.5	0.161	7.0	62.0	0.99395	3.62	0.61	11.0	5	0	red
41	5.4	0.22	0.29	1.2	0.045	69.0	152.0	0.99178	3.76	0.63	11.0	7	1	white
42	5.4	0.595	0.1	2.8	0.042	26.0	80.0	0.9932	3.36	0.38	9.3	5	0	white
43	5.4	0.74	0.09	1.7	0.089	16.0	26.0	0.99402	3.67	0.56	11.6	6	0	red
44	5.5	0.12	0.33	1.0	0.038	23.0	131.0	0.99164	3.25	0.45	9.8	5	0	white
45	5.5	0.12	0.33	1.0	0.038	23.0	131.0	0.99164	3.25	0.45	9.8	5	0	white
46	5.5	0.14	0.27	4.6	0.029	22.0	104.0	0.9949	3.34	0.44	9.0	5	0	white
47	5.5	0.14	0.27	4.6	0.029	22.0	104.0	0.9949	3.34	0.44	9.0	5	0	white
48	5.5	0.16	0.31	1.2	0.026	31.0	68.0	0.9898	3.33	0.44	11.65	6	0	white
49	5.5	0.16	0.31	1.2	0.026	31.0	68.0	0.9898	3.33	0.44	11.6333333333333	6	0	white
50	5.5	0.18	0.22	5.5	0.037	10.0	86.0	0.99156	3.46	0.44	12.2	5	0	white
51	5.5	0.24	0.45	1.7	0.046	22.0	113.0	0.99224	3.22	0.48	10.0	5	0	white
52	5.5	0.29	0.3	1.1	0.022	20.0	110.0	0.98869	3.34	0.38	12.8	7	1	white
53	5.5	0.31	0.29	3.0	0.027	16.0	102.0	0.99067	3.23	0.56	11.2	6	0	white
54	5.5	0.32	0.45	4.9	0.028	25.0	191.0	0.9922	3.51	0.49	11.5	7	1	white
55	5.5	0.35	0.35	1.1	0.045	14.0	167.0	0.992	3.34	0.68	9.9	6	0	white
56	5.5	0.375	0.38	1.7	0.036	17.0	98.0	0.99142	3.29	0.39	10.5	6	0	white
57	5.6	0.15	0.26	5.55	0.051	51.0	139.0	0.99336	3.47	0.5	11.0	6	0	white
58	5.6	0.15	0.31	5.3	0.038	8.0	79.0	0.9923	3.3	0.39	10.5	6	0	white
59	5.6	0.16	0.27	1.4	0.044	53.0	168.0	0.9918	3.28	0.37	10.1	6	0	white
60	5.6	0.175	0.29	0.8	0.043	20.0	67.0	0.99112	3.28	0.48	9.9	6	0	white
61	5.6	0.185	0.19	7.1	0.048	36.0	110.0	0.99438	3.26	0.41	9.5	6	0	white
62	5.6	0.185	0.19	7.1	0.048	36.0	110.0	0.99438	3.26	0.41	9.5	6	0	white
63	5.6	0.22	0.32	1.2	0.024	29.0	97.0	0.98823	3.2	0.46	13.05	7	1	white
64	5.6	0.26	0.18	1.4	0.034	18.0	135.0	0.99174	3.32	0.35	10.2	6	0	white
65	5.6	0.26	0.26	5.7	0.031	12.0	80.0	0.9923	3.25	0.38	10.8	5	0	white
66	5.6	0.26	0.5	11.4	0.029	25.0	93.0	0.99428	3.23	0.49	10.5	6	0	white
67	5.6	0.28	0.28	4.2	0.044	52.0	158.0	0.992	3.35	0.44	10.7	7	1	white
68	5.6	0.3	0.1	6.4	0.043	34.0	142.0	0.99382	3.14	0.48	9.8	5	0	white
69	5.6	0.35	0.14	5.0	0.046	48.0	198.0	0.9937	3.3	0.71	10.3	5	0	white
70	5.6	0.49	0.13	4.5	0.039	17.0	116.0	0.9907	3.42	0.9	13.7	7	1	white
71	5.6	0.49	0.13	4.5	0.039	17.0	116.0	0.9907	3.42	0.9	13.7	7	1	white
72	5.6	0.66	0.0	2.2	0.087	3.0	11.0	0.99378	3.71	0.63	12.8	7	1	red
73	5.6	0.66	0.0	2.2	0.087	3.0	11.0	0.99378	3.71	0.63	12.8	7	1	red
74	5.7	0.15	0.47	11.4	0.035	49.0	128.0	0.99456	3.03	0.34	10.5	8	1	white
75	5.7	0.18	0.26	2.2	0.023	21.0	95.0	0.9893	3.07	0.54	12.3	6	0	white
76	5.7	0.18	0.36	1.2	0.046	9.0	71.0	0.99199	3.7	0.68	10.9	7	1	white
77	5.7	0.2	0.3	2.5	0.046	38.0	125.0	0.99276	3.34	0.5	9.9	6	0	white
78	5.7	0.21	0.32	0.9	0.038	38.0	121.0	0.99074	3.24	0.46	10.6	6	0	white
79	5.7	0.21	0.37	4.5	0.04	58.0	140.0	0.99332	3.29	0.62	10.6	6	0	white
80	5.7	0.22	0.2	16.0	0.044	41.0	113.0	0.99862	3.22	0.46	8.9	6	0	white
81	5.7	0.22	0.2	16.0	0.044	41.0	113.0	0.99862	3.22	0.46	8.9	6	0	white
82	5.7	0.22	0.2	16.0	0.044	41.0	113.0	0.99862	3.22	0.46	8.9	6	0	white
83	5.7	0.22	0.2	16.0	0.044	41.0	113.0	0.99862	3.22	0.46	8.9	6	0	white
84	5.7	0.22	0.2	16.0	0.044	41.0	113.0	0.99862	3.22	0.46	8.9	6	0	white
85	5.7	0.22	0.29	3.5	0.04	27.0	146.0	0.98999	3.17	0.36	12.1	6	0	white
86	5.7	0.23	0.28	9.65	0.025	26.0	121.0	0.9925	3.28	0.38	11.3	6	0	white
87	5.7	0.25	0.26	12.5	0.049	52.5	106.0	0.99691	3.08	0.45	9.4	6	0	white
88	5.7	0.25	0.26	12.5	0.049	52.5	120.0	0.99691	3.08	0.45	9.4	6	0	white
89	5.7	0.25	0.27	11.5	0.04	24.0	120.0	0.99411	3.33	0.31	10.8	6	0	white
90	5.7	0.26	0.24	17.8	0.059	23.0	124.0	0.99773	3.3	0.5	10.1	5	0	white
91	5.7	0.26	0.24	17.8	0.059	23.0	124.0	0.99773	3.3	0.5	10.1	5	0	white
92	5.7	0.26	0.24	17.8	0.059	23.0	124.0	0.99773	3.3	0.5	10.1	5	0	white
93	5.7	0.27	0.32	1.2	0.046	20.0	155.0	0.9934	3.8	0.41	10.2	6	0	white
94	5.7	0.28	0.24	17.5	0.044	60.0	167.0	0.9989	3.31	0.44	9.4	5	0	white
95	5.7	0.32	0.18	1.4	0.029	26.0	104.0	0.9906	3.44	0.37	11.0	6	0	white
96	5.7	0.32	0.38	4.75	0.033	23.0	94.0	0.991	3.42	0.42	11.8	7	1	white
97	5.7	0.36	0.34	4.2	0.026	21.0	77.0	0.9907	3.41	0.45	11.9	6	0	white
98	5.8	0.14	0.15	6.1	0.042	27.0	123.0	0.99362	3.06	0.6	9.9	6	0	white
99	5.8	0.15	0.32	1.2	0.037	14.0	119.0	0.99137	3.19	0.5	10.2	6	0	white
100	5.8	0.17	0.34	1.8	0.045	96.0	170.0	0.99035	3.38	0.9	11.8	8	1	white

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.

Model Initialization

First we import the BisectingKMeans model:

from verticapy.machine_learning.vertica import BisectingKMeans

Then we can create the model:

model = BisectingKMeans(
    n_cluster = 8,
    bisection_iterations = 1,
    split_method = 'sum_squares',
    min_divisible_cluster_size = 2,
    distance_method = "euclidean",
    init = "kmeanspp",
    max_iter = 300,
    tol = 1e-4,
)

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(data, X = ["density", "sulphates"])


======
BKTree
======
center_id|density |sulphates|withinss |totWithinss|bisection_level|cluster_size|parent|left_child|right_child
---------+--------+---------+---------+-----------+---------------+------------+------+----------+-----------
    0    | 0.99470| 0.53127 |143.90056| 143.90056 |       0       |    6497    |      |    1     |     2     
    1    | 0.99437| 0.46796 |30.19361 | 60.86574  |       1       |    4946    |  0   |    3     |     4     
    2    | 0.99573| 0.73315 |30.67213 | 60.86574  |       1       |    1551    |  0   |    11    |    12     
    3    | 0.99490| 0.52428 | 5.15288 | 39.79475  |       2       |    2835    |  1   |    5     |     6     
    4    | 0.99367| 0.39233 | 3.96974 | 39.79475  |       2       |    2111    |  1   |    7     |     8     
    5    | 0.99487| 0.49384 | 0.87842 | 36.02969  |       3       |    1670    |  3   |    9     |    10     
    6    | 0.99493| 0.56791 | 0.50940 | 36.02969  |       3       |    1165    |  3   |          |           
    7    | 0.99300| 0.33971 | 0.52276 | 33.41748  |       4       |    652     |  4   |          |           
    8    | 0.99397| 0.41584 | 0.83476 | 33.41748  |       4       |    1459    |  4   |    13    |    14     
    9    | 0.99475| 0.47428 | 0.11483 | 32.77201  |       5       |    839     |  5   |          |           
   10    | 0.99499| 0.51360 | 0.11812 | 32.77201  |       5       |    831     |  5   |          |           
   11    | 0.99566| 0.69586 | 6.34160 | 15.92741  |       6       |    1375    |  2   |          |           
   12    | 0.99625| 1.02443 | 7.48592 | 15.92741  |       6       |    176     |  2   |          |           
   13    | 0.99426| 0.43548 | 0.10106 | 15.28590  |       7       |    777     |  8   |          |           
   14    | 0.99364| 0.39346 | 0.09220 | 15.28590  |       7       |    682     |  8   |          |           


=======
Metrics
=======
                       Measure                       |  Value  
-----------------------------------------------------+---------
                Total sum of squares                 |143.90056
         Total within-cluster sum of squares         |15.28590 
           Between-cluster sum of squares            |128.61466
Between-cluster sum of squares / Total sum of squares|89.37746 
      Sum of squares for cluster 1, center_id 9      | 0.11483 
     Sum of squares for cluster 2, center_id 10      | 0.11812 
      Sum of squares for cluster 3, center_id 6      | 0.50940 
      Sum of squares for cluster 4, center_id 7      | 0.52276 
     Sum of squares for cluster 5, center_id 13      | 0.10106 
     Sum of squares for cluster 6, center_id 14      | 0.09220 
     Sum of squares for cluster 7, center_id 11      | 6.34160 
     Sum of squares for cluster 8, center_id 12      | 7.48592 


===========
call_string
===========
bisecting_kmeans('"public"."_verticapy_tmp_bisectingkmeans_v_mldb_0b1588e2979611efa8720242ac120002_"', '"public"."_verticapy_tmp_view_v_mldb_0b46199e979611efa8720242ac120002_"', '"density", "sulphates"', 8
USING PARAMETERS bisection_iterations=1, split_method='SUM_SQUARES', min_divisible_cluster_size=2, distance_method='euclidean', kmeans_center_init_method='kmeanspp', kmeans_epsilon=0.0001, kmeans_max_iterations=300, key_columns=''"density", "sulphates"'')

===============
Additional Info
===============
        Name         |Value
---------------------+-----
   num_of_clusters   |  8  
dimensions_of_dataset|  2  
num_of_clusters_found|  8  
  height_of_BKTree   |  5  

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.

Hint

For clustering and anomaly detection, the use of predictors is optional. In such cases, all available predictors are considered, which can include solely numerical variables or a combination of numerical and categorical variables, depending on the model’s capabilities.

Metrics

You can also find the cluster positions by:

model.clusters_
Out[4]: 
array([[0.99469663, 0.53126828],
       [0.99437236, 0.46796199],
       [0.9957307 , 0.73314636],
       [0.99489568, 0.52428219],
       [0.99366957, 0.39232591],
       [0.99487069, 0.49384431],
       [0.99493149, 0.56791416],
       [0.99299846, 0.33970859],
       [0.99396948, 0.41583962],
       [0.99475134, 0.4742789 ],
       [0.99499119, 0.51359807],
       [0.99566435, 0.69586182],
       [0.99624909, 1.02443182],
       [0.99426018, 0.43548263],
       [0.99363829, 0.39346041]])

In order to get the size of each cluster, you can use:

model.cluster_size_
Out[5]: 
array([6497, 4946, 1551, 2835, 2111, 1670, 1165,  652, 1459,  839,  831,
       1375,  176,  777,  682])

To evaluate the model, various attributes are computed, such as the between sum of squares, the total within clusters sum of squares, and the total sum of squares.

model.between_cluster_ss_
Out[6]: 128.614661

model.total_within_cluster_ss_
Out[7]: 15.285901

model.total_ss_
Out[8]: 143.900562

You also have access to the sum of squares of each cluster.

model.cluster_i_ss_
Out[9]: 
array([0.114831, 0.118122, 0.509403, 0.522764, 0.101056, 0.092198,
       6.341603, 7.485924])

Some other useful attributes can be used to evaluate the model, like the Elbow Score (the bigger it is, the better it is).

model.elbow_score_
Out[10]: 89.3774556627513

Prediction

Predicting or ranking the dataset is straight-forward:

model.predict(data, ["density", "sulphates"])

	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 Integer
1	4.4	0.32	0.39	4.3	0.03	31.0	127.0	0.98904	3.46	0.36	12.8	8	1	white
2	4.4	0.46	0.1	2.8	0.024	31.0	111.0	0.98816	3.48	0.34	13.1	6	0	white
3	4.4	0.54	0.09	5.1	0.038	52.0	97.0	0.99022	3.41	0.4	12.2	7	1	white
4	4.7	0.6	0.17	2.3	0.058	17.0	106.0	0.9932	3.85	0.6	12.9	6	0	red
5	4.7	0.67	0.09	1.0	0.02	5.0	9.0	0.98722	3.3	0.34	13.6	5	0	white
6	4.8	0.33	0.0	6.5	0.028	34.0	163.0	0.9937	3.35	0.61	9.9	5	0	white
7	4.8	0.34	0.0	6.5	0.028	33.0	163.0	0.9939	3.36	0.61	9.9	6	0	white
8	4.9	0.47	0.17	1.9	0.035	60.0	148.0	0.98964	3.27	0.35	11.5	6	0	white
9	5.0	0.27	0.32	4.5	0.032	58.0	178.0	0.98956	3.45	0.31	12.6	7	1	white
10	5.0	0.27	0.32	4.5	0.032	58.0	178.0	0.98956	3.45	0.31	12.6	7	1	white
11	5.0	0.29	0.54	5.7	0.035	54.0	155.0	0.98976	3.27	0.34	12.9	8	1	white
12	5.0	0.33	0.18	4.6	0.032	40.0	124.0	0.99114	3.18	0.4	11.0	6	0	white
13	5.0	0.38	0.01	1.6	0.048	26.0	60.0	0.99084	3.7	0.75	14.0	6	0	red
14	5.0	0.55	0.14	8.3	0.032	35.0	164.0	0.9918	3.53	0.51	12.5	8	1	white
15	5.0	0.61	0.12	1.3	0.009	65.0	100.0	0.9874	3.26	0.37	13.5	5	0	white
16	5.1	0.21	0.28	1.4	0.047	48.0	148.0	0.99168	3.5	0.49	10.4	5	0	white
17	5.1	0.23	0.18	1.0	0.053	13.0	99.0	0.98956	3.22	0.39	11.5	5	0	white
18	5.1	0.25	0.36	1.3	0.035	40.0	78.0	0.9891	3.23	0.64	12.1	7	1	white
19	5.1	0.26	0.34	6.4	0.034	26.0	99.0	0.99449	3.23	0.41	9.2	6	0	white
20	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
21	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
22	5.1	0.35	0.26	6.8	0.034	36.0	120.0	0.99188	3.38	0.4	11.5	6	0	white
23	5.1	0.47	0.02	1.3	0.034	18.0	44.0	0.9921	3.9	0.62	12.8	6	0	red
24	5.1	0.585	0.0	1.7	0.044	14.0	86.0	0.99264	3.56	0.94	12.9	7	1	red
25	5.2	0.185	0.22	1.0	0.03	47.0	123.0	0.99218	3.55	0.44	10.15	6	0	white
26	5.2	0.24	0.45	3.8	0.027	21.0	128.0	0.992	3.55	0.49	11.2	8	1	white
27	5.2	0.24	0.45	3.8	0.027	21.0	128.0	0.992	3.55	0.49	11.2	8	1	white
28	5.2	0.28	0.29	1.1	0.028	18.0	69.0	0.99168	3.24	0.54	10.0	6	0	white
29	5.2	0.34	0.0	1.8	0.05	27.0	63.0	0.9916	3.68	0.79	14.0	6	0	red
30	5.2	0.34	0.0	1.8	0.05	27.0	63.0	0.9916	3.68	0.79	14.0	6	0	red
31	5.2	0.405	0.15	1.45	0.038	10.0	44.0	0.99125	3.52	0.4	11.6	4	0	white
32	5.2	0.6	0.07	7.0	0.044	33.0	147.0	0.9944	3.33	0.58	9.7	5	0	white
33	5.2	0.645	0.0	2.15	0.08	15.0	28.0	0.99444	3.78	0.61	12.5	6	0	red
34	5.3	0.2	0.31	3.6	0.036	22.0	91.0	0.99278	3.41	0.5	9.8	6	0	white
35	5.3	0.24	0.33	1.3	0.033	25.0	97.0	0.9906	3.59	0.38	11.0	8	1	white
36	5.3	0.31	0.38	10.5	0.031	53.0	140.0	0.99321	3.34	0.46	11.7	6	0	white
37	5.3	0.31	0.38	10.5	0.031	53.0	140.0	0.99321	3.34	0.46	11.7	6	0	white
38	5.3	0.395	0.07	1.3	0.035	26.0	102.0	0.992	3.5	0.35	10.6	6	0	white
39	5.3	0.43	0.11	1.1	0.029	6.0	51.0	0.99076	3.51	0.48	11.2	4	0	white
40	5.3	0.58	0.07	6.9	0.043	34.0	149.0	0.9944	3.34	0.57	9.7	5	0	white
41	5.3	0.585	0.07	7.1	0.044	34.0	145.0	0.9945	3.34	0.57	9.7	6	0	white
42	5.3	0.76	0.03	2.7	0.043	27.0	93.0	0.9932	3.34	0.38	9.2	5	0	white
43	5.4	0.18	0.24	4.8	0.041	30.0	113.0	0.99445	3.42	0.4	9.4	6	0	white
44	5.4	0.205	0.16	12.55	0.051	31.0	115.0	0.99564	3.4	0.38	10.8	6	0	white
45	5.4	0.255	0.33	1.2	0.051	29.0	122.0	0.99048	3.37	0.66	11.3	6	0	white
46	5.4	0.29	0.38	1.2	0.029	31.0	132.0	0.98895	3.28	0.36	12.4	6	0	white
47	5.4	0.29	0.38	1.2	0.029	31.0	132.0	0.98895	3.28	0.36	12.4	6	0	white
48	5.4	0.45	0.27	6.4	0.033	20.0	102.0	0.98944	3.22	0.27	13.4	8	1	white
49	5.4	0.5	0.13	5.0	0.028	12.0	107.0	0.99079	3.48	0.88	13.5	7	1	white
50	5.4	0.53	0.16	2.7	0.036	34.0	128.0	0.98856	3.2	0.53	13.2	8	1	white
51	5.4	0.53	0.16	2.7	0.036	34.0	128.0	0.98856	3.2	0.53	13.2	8	1	white
52	5.4	0.59	0.07	7.0	0.045	36.0	147.0	0.9944	3.34	0.57	9.7	6	0	white
53	5.5	0.16	0.26	1.5	0.032	35.0	100.0	0.99076	3.43	0.77	12.0	6	0	white
54	5.5	0.19	0.27	0.9	0.04	52.0	103.0	0.99026	3.5	0.39	11.2	5	0	white
55	5.5	0.23	0.19	2.2	0.044	39.0	161.0	0.99209	3.19	0.43	10.4	6	0	white
56	5.5	0.24	0.32	8.7	0.06	19.0	102.0	0.994	3.27	0.31	10.4	5	0	white
57	5.6	0.18	0.27	1.7	0.03	31.0	103.0	0.98892	3.35	0.37	12.9	6	0	white
58	5.6	0.18	0.29	2.3	0.04	5.0	47.0	0.99126	3.07	0.45	10.1	4	0	white
59	5.6	0.18	0.3	10.2	0.028	28.0	131.0	0.9954	3.49	0.42	10.8	7	1	white
60	5.6	0.18	0.31	1.5	0.038	16.0	84.0	0.9924	3.34	0.58	10.1	6	0	white
61	5.6	0.185	0.49	1.1	0.03	28.0	117.0	0.9918	3.55	0.45	10.3	6	0	white
62	5.6	0.19	0.26	1.4	0.03	12.0	76.0	0.9905	3.25	0.37	10.9	7	1	white
63	5.6	0.19	0.27	0.9	0.04	52.0	103.0	0.99026	3.5	0.39	11.2	5	0	white
64	5.6	0.19	0.31	2.7	0.027	11.0	100.0	0.98964	3.46	0.4	13.2	7	1	white
65	5.6	0.19	0.46	1.1	0.032	33.0	115.0	0.9909	3.36	0.5	10.4	6	0	white
66	5.6	0.2	0.66	10.2	0.043	78.0	175.0	0.9945	2.98	0.43	10.4	7	1	white
67	5.6	0.205	0.16	12.55	0.051	31.0	115.0	0.99564	3.4	0.38	10.8	6	0	white
68	5.6	0.225	0.24	9.8	0.054	59.0	140.0	0.99545	3.17	0.39	10.2	6	0	white
69	5.6	0.23	0.25	8.0	0.043	31.0	101.0	0.99429	3.19	0.42	10.4	6	0	white
70	5.6	0.23	0.29	3.1	0.023	19.0	89.0	0.99068	3.25	0.51	11.2	6	0	white
71	5.6	0.235	0.29	1.2	0.047	33.0	127.0	0.991	3.34	0.5	11.0	7	1	white
72	5.6	0.27	0.37	0.9	0.025	11.0	49.0	0.98845	3.29	0.33	13.1	6	0	white
73	5.6	0.28	0.27	3.9	0.043	52.0	158.0	0.99202	3.35	0.44	10.7	7	1	white
74	5.6	0.29	0.05	0.8	0.038	11.0	30.0	0.9924	3.36	0.35	9.2	5	0	white
75	5.6	0.295	0.2	2.2	0.049	18.0	134.0	0.99378	3.21	0.68	10.0	5	0	white
76	5.6	0.31	0.37	1.4	0.074	12.0	96.0	0.9954	3.32	0.58	9.2	5	0	red
77	5.6	0.33	0.28	1.2	0.031	33.0	97.0	0.99126	3.49	0.58	10.9	6	0	white
78	5.6	0.34	0.1	1.3	0.031	20.0	68.0	0.9906	3.36	0.51	11.2	7	1	white
79	5.6	0.34	0.25	2.5	0.046	47.0	182.0	0.99093	3.21	0.4	11.3	5	0	white
80	5.6	0.39	0.24	4.7	0.034	27.0	77.0	0.9906	3.28	0.36	12.7	5	0	white
81	5.6	0.41	0.22	7.1	0.05	44.0	154.0	0.9931	3.3	0.4	10.5	5	0	white
82	5.6	0.46	0.24	4.8	0.042	24.0	72.0	0.9908	3.29	0.37	12.6	6	0	white
83	5.6	0.5	0.09	2.3	0.049	17.0	99.0	0.9937	3.63	0.63	13.0	5	0	red
84	5.6	0.5	0.09	2.3	0.049	17.0	99.0	0.9937	3.63	0.63	13.0	5	0	red
85	5.6	0.605	0.05	2.4	0.073	19.0	25.0	0.99258	3.56	0.55	12.9	5	0	red
86	5.6	0.695	0.06	6.8	0.042	9.0	84.0	0.99432	3.44	0.44	10.2	5	0	white
87	5.7	0.135	0.3	4.6	0.042	19.0	101.0	0.9946	3.31	0.42	9.3	6	0	white
88	5.7	0.14	0.3	5.4	0.045	26.0	105.0	0.99469	3.32	0.45	9.3	5	0	white
89	5.7	0.18	0.22	4.2	0.042	25.0	111.0	0.994	3.35	0.39	9.4	5	0	white
90	5.7	0.22	0.22	16.65	0.044	39.0	110.0	0.99855	3.24	0.48	9.0	6	0	white
91	5.7	0.22	0.22	16.65	0.044	39.0	110.0	0.99855	3.24	0.48	9.0	6	0	white
92	5.7	0.22	0.22	16.65	0.044	39.0	110.0	0.99855	3.24	0.48	9.0	6	0	white
93	5.7	0.22	0.22	16.65	0.044	39.0	110.0	0.99855	3.24	0.48	9.0	6	0	white
94	5.7	0.22	0.28	1.3	0.027	26.0	101.0	0.98948	3.35	0.38	12.5	7	1	white
95	5.7	0.245	0.33	1.1	0.049	28.0	150.0	0.9927	3.13	0.42	9.3	5	0	white
96	5.7	0.25	0.21	1.5	0.044	21.0	108.0	0.99142	3.3	0.59	11.0	6	0	white
97	5.7	0.255	0.65	1.2	0.079	17.0	137.0	0.99307	3.2	0.42	9.4	5	0	white
98	5.7	0.255	0.65	1.2	0.079	17.0	137.0	0.99307	3.2	0.42	9.4	5	0	white
99	5.7	0.28	0.3	3.9	0.026	36.0	105.0	0.98963	3.26	0.58	12.75	6	0	white
100	5.7	0.31	0.29	7.3	0.05	33.0	143.0	0.99332	3.31	0.5	11.0666666666667	6	0	white

Rows: 1-100 | Columns: 15

As shown above, a new column has been created, containing the bisected clusters.

Plots - Cluster Plot

Plots highlighting the different clusters can be easily drawn using:

model.plot()

Plots - Tree

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

model.plot_tree()

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[11]: 'digraph Tree {\ngraph [rankdir = "LR"];\n0 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 0 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 6497 </td></tr><tr><td port="port3" border="1" align="left"> score: 1.0 </td></tr></table>>, shape="none"]\n0 -> 1 [label=""]\n0 -> 2 [label=""]\n1 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 1 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 4946 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.5 </td></tr></table>>, shape="none"]\n1 -> 3 [label=""]\n1 -> 4 [label=""]\n2 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 2 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 1551 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.5 </td></tr></table>>, shape="none"]\n2 -> 11 [label=""]\n2 -> 12 [label=""]\n3 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 3 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 2835 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.13 </td></tr></table>>, shape="none"]\n3 -> 5 [label=""]\n3 -> 6 [label=""]\n4 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 4 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 2111 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.1 </td></tr></table>>, shape="none"]\n4 -> 7 [label=""]\n4 -> 8 [label=""]\n5 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 5 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 1670 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.02 </td></tr></table>>, shape="none"]\n5 -> 9 [label=""]\n5 -> 10 [label=""]\n6 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 6 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 1165 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.01 </td></tr></table>>, shape="none"]\n7 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 7 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 652 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.02 </td></tr></table>>, shape="none"]\n8 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#87cefa"><b> cluster_id: 8 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 1459 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.02 </td></tr></table>>, shape="none"]\n8 -> 13 [label=""]\n8 -> 14 [label=""]\n9 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 9 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 839 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.0 </td></tr></table>>, shape="none"]\n10 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 10 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 831 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.0 </td></tr></table>>, shape="none"]\n11 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 11 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 1375 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.4 </td></tr></table>>, shape="none"]\n12 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 12 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 176 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.47 </td></tr></table>>, shape="none"]\n13 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 13 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 777 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.01 </td></tr></table>>, shape="none"]\n14 [label=<<table border="0" cellspacing="0"> <tr><td port="port1" border="1" bgcolor="#efc5b5"><b> cluster_id: 14 </b></td></tr><tr><td port="port2" border="1" align="left"> size: 682 </td></tr><tr><td port="port3" border="1" align="left"> score: 0.01 </td></tr></table>>, shape="none"]\n}'

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

Plots - Contour

In order to understand the parameter space, we can also look at the contour plots:

model.contour()

Note

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 chart_gallery.contour_plot for more examples.

Parameter Modification

In order to see the parameters:

model.get_params()
Out[12]: 
{'n_cluster': 8,
 'bisection_iterations': 1,
 'split_method': 'sum_squares',
 'min_divisible_cluster_size': 2,
 'distance_method': 'euclidean',
 'init': 'kmeanspp',
 'max_iter': 300,
 'tol': 0.0001}

And to manually change some of the parameters:

model.set_params({'n_cluster': 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 preceding methods for exporting the model use MemModel, and it is recommended to use MemModel directly.

To SQL

You can get the SQL query equivalent of the XGB model by:

model.to_sql()
Out[14]: '(CASE WHEN "density" IS NULL OR "sulphates" IS NULL THEN NULL ELSE (CASE WHEN POWER(POWER("density" - 0.994372363526082, 2) + POWER("sulphates" - 0.467961989486454, 2), 1/2) < POWER(POWER("density" - 0.995730702772405, 2) + POWER("sulphates" - 0.73314635718891, 2), 1/2) THEN (CASE WHEN POWER(POWER("density" - 0.994895675485009, 2) + POWER("sulphates" - 0.524282186948854, 2), 1/2) < POWER(POWER("density" - 0.993669573661772, 2) + POWER("sulphates" - 0.3923259118901, 2), 1/2) THEN (CASE WHEN POWER(POWER("density" - 0.994870691616766, 2) + POWER("sulphates" - 0.493844311377245, 2), 1/2) < POWER(POWER("density" - 0.994931489270386, 2) + POWER("sulphates" - 0.567914163090129, 2), 1/2) THEN (CASE WHEN POWER(POWER("density" - 0.994751340882002, 2) + POWER("sulphates" - 0.474278903456496, 2), 1/2) < POWER(POWER("density" - 0.99499119133574, 2) + POWER("sulphates" - 0.513598074608905, 2), 1/2) THEN 9 ELSE 10 END) ELSE 6 END) ELSE (CASE WHEN POWER(POWER("density" - 0.992998458588957, 2) + POWER("sulphates" - 0.339708588957055, 2), 1/2) < POWER(POWER("density" - 0.993969482522276, 2) + POWER("sulphates" - 0.415839616175463, 2), 1/2) THEN 7 ELSE (CASE WHEN POWER(POWER("density" - 0.99426018018018, 2) + POWER("sulphates" - 0.435482625482626, 2), 1/2) < POWER(POWER("density" - 0.993638291788856, 2) + POWER("sulphates" - 0.393460410557185, 2), 1/2) THEN 13 ELSE 14 END) END) END) ELSE (CASE WHEN POWER(POWER("density" - 0.995664349090909, 2) + POWER("sulphates" - 0.695861818181818, 2), 1/2) < POWER(POWER("density" - 0.996249090909091, 2) + POWER("sulphates" - 1.02443181818182, 2), 1/2) THEN 11 ELSE 12 END) END) END)'

Note

This SQL query can be directly used in any database.

Deploy SQL

To get the SQL query which uses Vertica functions use below:

model.deploySQL()
Out[15]: 'APPLY_BISECTING_KMEANS("density", "sulphates" USING PARAMETERS model_name = \'"public"."_verticapy_tmp_bisectingkmeans_v_mldb_0b1588e2979611efa8720242ac120002_"\', match_by_pos = \'true\')'

To Python

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

X = [[0.9, 0.5]]

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

Hint

The to_python() method is used to retrieve the anomaly score. 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_cluster: int = 8, bisection_iterations: int = 1, split_method: Literal['size', 'sum_squares'] = 'sum_squares', min_divisible_cluster_size: int = 2, distance_method: Literal['euclidean'] = 'euclidean', init: Literal['kmeanspp', 'pseudo', 'random'] | list = 'kmeanspp', max_iter: int = 300, tol: float = 0.0001) → None

Must be overridden in the child class

Methods

__init__([name, overwrite_model, n_cluster, ...])	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, return_report])	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()	Returns a table containing information about the BK-tree.
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([pic_path])	Draws the input tree.
plot_voronoi([max_nb_points, plot_crosses, ...])	Draws the Voronoi Graph of the model.
predict(vdf[, X, name, inplace])	Makes predictions 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'.
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([round_score, percent, ...])	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

object_type