API Reference

Complete Python API documentation for changepoint-doctor.

• Offline Detectors
  • Pelt
  • Binseg
  • Fpop
• Online Detectors
  • Bocpd
  • Cusum
  • PageHinkley
• Result Types
  • OfflineChangePointResult
  • OnlineStepResult
• Diagnostics
  • Diagnostics
  • BuildInfo
  • PruningStats
  • SegmentStats
• Functions
  • detect_offline()
  • smoke_detect()

Quick import reference

import cpd

# Offline detectors
cpd.Pelt, cpd.Binseg, cpd.Fpop

# Online detectors
cpd.Bocpd, cpd.Cusum, cpd.PageHinkley

# Result types
cpd.OfflineChangePointResult, cpd.OnlineStepResult

# Diagnostics
cpd.Diagnostics, cpd.PruningStats, cpd.SegmentStats

# Functions
cpd.detect_offline, cpd.smoke_detect