Skip to main content
Version: 0.3.x

Base class

Base class for scikit-learn API compatibility.

Provides the get_params and set_params methods for compatibility with the scikit-learn API, allowing access to the model's public parameters.

Function set_params(...)

def set_params(self, **params)

Set the parameters of the instance. Ensures compatibility with scikit-learn functions.

Parameters:

  • params: dict Dictionary of parameters to set as attributes on the instance. Only public attributes (not starting with "_") are modified.

Returns:

  • self: Base Returns the instance itself after setting the parameters.

Function get_params(...)

def get_params(self, deep: bool = True) -> dict

Return a dictionary with the object's main parameters. Ensures compatibility with scikit-learn functions.

Parameters:

  • deep: bool Ignored in this implementation but included for scikit-learn compatibility.

Returns:

  • params: dict Dictionary containing the object's attributes that do not start with "_".

Utility Functions

Function set_seed_numba(...)

@njit(cache=True)
def set_seed_numba(seed: int)

Set the seed for random numbers used by functions compiled with Numba.

Parameters:

  • seed: int Integer value used to initialize Numba's random number generator.