cubist 1.2.2

A Python package for fitting Ross Quinlan's Cubist regression model.

Cubist

cubist is a Python package and wrapper for Ross Quinlan's Cubist v2.07 rule-based regression model with additional utilities for visualizing a trained model. The package is both inspired by and a translation of the R wrapper for Cubist. This implementation of the model is compatible with and the visualization utilities are designed after those in scikit-learn.

Table of Contents generated with DocToc

• Model Features
• Installation
  • Model-Only
  • Enable Visualization Utilities
• Usage with Verbose Output
• Package Contents

Model Features

The Cubist model has the following distinguishing features, though not all are fully enabled in this package:

• Generates a piecewise model formulated as a collection of conditional rules with corresponding linear regressors (optionally allowing for nearest-neighbor correction).
• High interpretability due to piecewise rules and linear regressors.
• Handles missing values.
• Handles continuous, date, time, timestamp, and discrete values. Additionally can ignore columns and add labels to training rows. Columns can also be defined by formulas. N.B. Not all of these are supported in this package.
• Natively performs cross-validation and sampling.
• Error can be further reduced by using multiple models (committees).
• Allows for extrapolation beyond the original training target values (sets a minimum of zero for predicted output if all training target values are greater than zero).

Installation

Model-Only

pip install --upgrade cubist

or for those in the know:

uv add cubist

Enable Visualization Utilities

pip install cubist[viz]

or

uv add cubist --extra viz

Usage with Verbose Output

>>> from sklearn.datasets import load_iris
>>> from sklearn.model_selection import train_test_split
>>> from cubist import Cubist
>>> X, y = load_iris(return_X_y=True, as_frame=True)
>>> X_train, X_test, y_train, y_test = train_test_split(
        X, y, test_size=0.05
    )
>>> X_train, X_test, y_train, y_test = train_test_split(
        X, y, test_size=0.05
    )
>>> model = Cubist(n_rules=2, verbose=True)
>>> model.fit(X_train, y_train)

Cubist [Release 2.07 GPL Edition]  Sat Dec 28 19:52:49 2024
---------------------------------

    Target attribute `outcome'

Read 142 cases (5 attributes)

Model:

  Rule 1: [48 cases, mean 0.0, range 0 to 0, est err 0.0]

    if
        petal width (cm) <= 0.6
    then
        outcome = 0

  Rule 2: [94 cases, mean 1.5, range 1 to 2, est err 0.2]

    if
        petal width (cm) > 0.6
    then
        outcome = 0.2 + 0.76 petal width (cm) + 0.271 petal length (cm)
                  - 0.45 sepal width (cm)


Evaluation on training data (142 cases):

    Average  |error|                0.1
    Relative |error|               0.16
    Correlation coefficient        0.98


        Attribute usage:
          Conds  Model

          100%    66%    petal width (cm)
                  66%    sepal width (cm)
                  66%    petal length (cm)


Time: 0.0 secs

Cubist(n_rules=2, verbose=True)
>>> model.predict(X_test)
array([1.1257    , 0.        , 2.04999995, 1.25449991, 1.30480003,
       0.        , 0.94999999, 1.93509996])
>>> model.score(X_test, y_test)
0.9543285583162371

Package Contents

• Cubist model exposed as a scikit-learn estimator.
• Visualization utilities for:
  • Exploring the coefficients of the linear regressors.
  • Assessing the coverage of rules over an input dataset.