tsa.inferred_freq#

mainsource.inferred_freq(name, revision_date=None, from_value_date=None, to_value_date=None)#

Return a tuple of timedelta, float (between 0 and 1).

The timedelta represents the period (or ‘freq’ in pandas parlance) and the number the quality of the period, which may vary because of the irregularity of the series.

Parameters:

  • name (str)

  • revision_date (Timestamp | None)

  • from_value_date (Timestamp | None)

  • to_value_date (Timestamp | None)

Return type:

Tuple[Timedelta, float] | None