tslumen.profile package

Package containing all the profiling functions, each operating at DataFrame or Series level, organized based on the main aspect they focus on or common theme. Profiling functions can be bundled as desired, the BundledProfiler class facilitates that.

class tslumen.profile.DefaultProfiler(config: Optional[Dict[str, Dict[str, Any]]] = None, scheduler: Optional[tslumen.scheduling.Scheduler] = None)[source]

Bases: tslumen.profile.base.BundledProfiler

Bundles all the profiling functions available in tslumen.profile, a convenient way to run a full analysis on any given timeseries dataset.

Parameters

  • config (Optional[dict]) – Profiler functions’ configurations. Whatever options are provided here will override the defaults. Expects a 2-level dictionary with the first level indexed by the name of the profiling functions and the second level the function’s parameters. Assumed configs (i.e. defaults + overrides) are stored in the class variable config.

  • scheduler (Optional[Scheduler]) – For executing the profiling functions. Instantiates the default one if not provided.