tslumen.report package¶

Reporting package, encloses all functionality to output/render/report the profiling results.

tslumen.report.base module¶

Base functionality for creating profiling Reports.

class tslumen.report.base.Report(df: pandas.core.frame.DataFrame, meta: Optional[dict] = None, result: Optional[tslumen.profile.base.BundledResult] = None, profiler: Optional[tslumen.profile.base.BundledProfiler] = None, profiler_config: Optional[dict] = None, scheduler: Optional[tslumen.scheduling.Scheduler] = None, scheduler_config: Optional[dict] = None)[source]¶

Bases: object

Base class for creating profiling Reports.

Parameters

df (pd.DataFrame) – Timeseries data.
meta (Optional[dict]) – Timeseries metadata, a 2-level dictionary, first level indexed by {'frame': {<key>: <value>}, {'series': {<series name>: <desc>}}.
result (Optional[BundledResult]) – For instantiating the report with pre-computed results from a profiler.
profiler (Optional[BundledProfiler]) – The BundledProfiler to run the profiling, defaults to DefaultProfiler.
profiler_config (Optional[dict]) – Profiler’s configurations.
scheduler (Optional[Scheduler]) – A Scheduler, default’s to Scheduler.
scheduler_config (Optional[dict]) – Scheduler’s configurations.