Skip to content

Model

This section documents the model components of the dummy module.

model

Defines sklearn.dummy models interoperability.

This module provides integration between nextmv and scikit-learn's dummy models.

FUNCTION DESCRIPTION
DummyRegressor : function

Creates a sklearn.dummy.DummyRegressor from provided options.

DummyRegressor 

DummyRegressor(options: Options) -> DummyRegressor

Creates a sklearn.dummy.DummyRegressor from the provided options.

You can import the DummyRegressor function directly from dummy:

from nextmv_sklearn.dummy import DummyRegressor

The DummyRegressor is a regressor that makes predictions using simple rules, which can be useful as a baseline for comparison against actual regressors.

PARAMETER DESCRIPTION

options

Options for the DummyRegressor. Should be created using DummyRegressorOptions.to_nextmv() from the options module.

TYPE: Options

RETURNS DESCRIPTION
DummyRegressor

A sklearn.dummy.DummyRegressor instance configured with the provided options.

Examples:

>>> from nextmv_sklearn.dummy import DummyRegressor
>>> from nextmv_sklearn.dummy.options import DummyRegressorOptions
>>> options = DummyRegressorOptions()
>>> # Configure options as needed
>>> regressor = DummyRegressor(options.to_nextmv())
>>> regressor.fit(X_train, y_train)
>>> predictions = regressor.predict(X_test)
Source code in nextmv-scikit-learn/nextmv_sklearn/dummy/model.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def DummyRegressor(options: nextmv.Options) -> dummy.DummyRegressor:
    """
    Creates a `sklearn.dummy.DummyRegressor` from the provided options.

    You can import the `DummyRegressor` function directly from `dummy`:

    ```python
    from nextmv_sklearn.dummy import DummyRegressor
    ```

    The DummyRegressor is a regressor that makes predictions using simple rules,
    which can be useful as a baseline for comparison against actual regressors.

    Parameters
    ----------
    options : nextmv.Options
        Options for the DummyRegressor. Should be created using
        DummyRegressorOptions.to_nextmv() from the options module.

    Returns
    -------
    sklearn.dummy.DummyRegressor
        A sklearn.dummy.DummyRegressor instance configured with the provided options.

    Examples
    --------
    >>> from nextmv_sklearn.dummy import DummyRegressor
    >>> from nextmv_sklearn.dummy.options import DummyRegressorOptions
    >>> options = DummyRegressorOptions()
    >>> # Configure options as needed
    >>> regressor = DummyRegressor(options.to_nextmv())
    >>> regressor.fit(X_train, y_train)
    >>> predictions = regressor.predict(X_test)
    """

    names = {p.name for p in DUMMY_REGRESSOR_PARAMETERS}
    opt_dict = {k: v for k, v in options.to_dict().items() if k in names if v is not None}

    return dummy.DummyRegressor(**opt_dict)