Skip to content


This section describes the API of all functions and classes in the ruptures package. For a more intuitive description of each method, please refer to the User guide.

Roughly, each module corresponds to a certain type of procedure:

  • ruptures.base: base classes;
  • ruptures.detection: search methods;
  • ruptures.costs: costs functions;
  • ruptures.datasets: data set generating utilities;
  • ruptures.metrics: evaluation metrics;
  • display functions.