Skip to content

catalog

catalog ¤

Programmatic catalog of ts-shape's public classes.

list_detectors() lets a power user discover the 60+ event detectors and loaders from a REPL or notebook instead of scanning the docs::

import ts_shape
ts_shape.list_detectors("events.quality")

list_detectors ¤

list_detectors(category: str | None = None) -> pd.DataFrame

Return a catalog of ts-shape's top-level public classes.

Parameters:

Name Type Description Default
category str | None

Optional filter matched as a prefix against the category column -- e.g. "events", "events.quality", "loader".

None

Returns:

Type Description
DataFrame

DataFrame with columns name, category and module -- one row

DataFrame

per class re-exported from ts_shape, sorted by category then name.