Migration & Deprecations¤

A running list of renames and deprecated aliases, so existing code keeps working while you migrate. Deprecated names still function but emit a DeprecationWarning; they may be removed in a future major release. The authoritative, dated record is the Changelog — this page is the quick old → new lookup.

Removed exporter aliases¤

The event-log exporters were renamed into a consistent to_event_log_* family. The old aliases (to_flat_df, to_ocel_tables) have now been removed — update any remaining imports:

Removed	Use instead
`to_flat_df(...)`	`to_event_log_xes(...)`
`to_ocel_tables(...)`	`to_event_log_ocel(...)`

# Before
from ts_shape.eventlog import to_flat_df, to_ocel_tables

# After
from ts_shape.eventlog import to_event_log_xes, to_event_log_ocel

`to_event_log_ocel` now returns five tables¤

To fully model OCEL 2.0, to_event_log_ocel(log) returns an OCEL2Tables bundle (object-to-object relations and time-varying object attributes were added) instead of a 3-tuple. Access the frames by attribute:

# Before
events_df, objects_df, relations_df = to_event_log_ocel(log)

# After
tables = to_event_log_ocel(log)
tables.events, tables.objects, tables.relations          # as before
tables.o2o, tables.object_changes                        # new OCEL 2.0 tables

`org:resource` in XES export¤

to_event_log_xes previously copied the case object id into org:resource. Per the XES standard org:resource is the performing resource, so it is now populated only from an operator-type object relation, and omitted when the log has no operators. Supply one via objects={"operator": ...} if you need it.

Class aliases¤

Alias (back-compat)	Canonical name	Notes
`OrderTraceabilityEvents`	`ValueTraceabilityEvents`	Same class; the alias tracks single-ID traceability that is no longer order-specific. New code should import `ValueTraceabilityEvents`.

Standardized detector output (May 2026)¤

Every public DataFrame-returning detector method now emits one of three canonical shapes — point, interval, or summary — defined in src/ts_shape/events/_output.py. If you previously read shape-specific column names, switch to the canonical ones:

Old column(s)	Canonical column
`start_time`, `gap_start`, `window_start`, `period_start`, `disturbance_start`	`start`
`end_time`, `gap_end`, `window_end`, `period_end`, `disturbance_end`	`end`
`severity_score`, `severity_level`	`severity`
`OEECalculator`: `date`	`start` + `end` + `duration_seconds` (86400)

See the Changelog for the full dated history of breaking changes.