Welcome to tsseg’s documentation!

Introduction

tsseg is a toolkit for time-series segmentation that offers a common API for algorithm wrappers, dataset helpers, and evaluation utilities. The documentation is organised into the following sections:

  • Getting started – install the package and run your first segmentation pipeline.

  • Datasets – explore the bundled datasets and how to load your own data.

  • Detectors overview – compare the available detectors and their capabilities.

  • API reference – dive into the API reference generated from the source code.

If you’re new to the project, start with the Getting started tutorial.