Base classes (ruptures.base)

All estimators and cost functions are subclasses of.

BaseEstimator and BaseCost respectively.

BaseCost

Bases: object

Base class for all segment cost classes.

Notes

All classes should specify all the parameters that can be set at the class level in their __init__ as explicit keyword arguments (no *args or **kwargs).

Source code in src/ruptures/base.py

class BaseCost(object, metaclass=abc.ABCMeta):
    """Base class for all segment cost classes.

    Notes:
        All classes should specify all the parameters that can be set
        at the class level in their ``__init__`` as explicit keyword
        arguments (no ``*args`` or ``**kwargs``).
    """

    @abc.abstractmethod
    def fit(self, *args, **kwargs):
        """Set the parameters of the cost function, for instance the Gram
        matrix, etc."""
        pass

    @abc.abstractmethod
    def error(self, start, end):
        """Returns the cost on segment [start:end]."""
        pass

    def sum_of_costs(self, bkps):
        """Returns the sum of segments cost for the given segmentation.

        Args:
            bkps (list): list of change points. By convention, bkps[-1]==n_samples.

        Returns:
            float: sum of costs
        """
        soc = sum(self.error(start, end) for start, end in pairwise([0] + bkps))
        return soc

    @property
    @abc.abstractmethod
    def model(self):
        pass

error(start, end) abstractmethod

Returns the cost on segment [start:end].

Source code in src/ruptures/base.py

@abc.abstractmethod
def error(self, start, end):
    """Returns the cost on segment [start:end]."""
    pass

fit(*args, **kwargs) abstractmethod

Set the parameters of the cost function, for instance the Gram matrix, etc.

Source code in src/ruptures/base.py

@abc.abstractmethod
def fit(self, *args, **kwargs):
    """Set the parameters of the cost function, for instance the Gram
    matrix, etc."""
    pass

sum_of_costs(bkps)

Returns the sum of segments cost for the given segmentation.

Parameters:

Name	Type	Description	Default
bkps	list	list of change points. By convention, bkps[-1]==n_samples.	required

Returns:

Name	Type	Description
float		sum of costs

Source code in src/ruptures/base.py

def sum_of_costs(self, bkps):
    """Returns the sum of segments cost for the given segmentation.

    Args:
        bkps (list): list of change points. By convention, bkps[-1]==n_samples.

    Returns:
        float: sum of costs
    """
    soc = sum(self.error(start, end) for start, end in pairwise([0] + bkps))
    return soc

BaseEstimator

Base class for all change point detection estimators.

Notes

All estimators should specify all the parameters that can be set at the class level in their __init__ as explicit keyword arguments (no *args or **kwargs).

Source code in src/ruptures/base.py

class BaseEstimator(metaclass=abc.ABCMeta):
    """Base class for all change point detection estimators.

    Notes:
        All estimators should specify all the parameters that can be set
        at the class level in their ``__init__`` as explicit keyword
        arguments (no ``*args`` or ``**kwargs``).
    """

    @abc.abstractmethod
    def fit(self, *args, **kwargs):
        """To call the segmentation algorithm."""
        pass

    @abc.abstractmethod
    def predict(self, *args, **kwargs):
        """To call the segmentation algorithm."""
        pass

    @abc.abstractmethod
    def fit_predict(self, *args, **kwargs):
        """To call the segmentation algorithm."""
        pass

fit(*args, **kwargs) abstractmethod

To call the segmentation algorithm.

Source code in src/ruptures/base.py

@abc.abstractmethod
def fit(self, *args, **kwargs):
    """To call the segmentation algorithm."""
    pass

fit_predict(*args, **kwargs) abstractmethod

To call the segmentation algorithm.

Source code in src/ruptures/base.py

@abc.abstractmethod
def fit_predict(self, *args, **kwargs):
    """To call the segmentation algorithm."""
    pass

predict(*args, **kwargs) abstractmethod

To call the segmentation algorithm.

Source code in src/ruptures/base.py

@abc.abstractmethod
def predict(self, *args, **kwargs):
    """To call the segmentation algorithm."""
    pass