hpipy.utils.metrics.revision#

class hpipy.utils.metrics.revision(series_obj, in_place=False, smooth=False)[source]

Bases:

Calculate the revision for a series of indices.

This is done by calculating the difference between consecutive indexes (n to n+1) and then calculating the mean and median of the differences. This is done for each period and the results are returned as a DataFrame.

Parameters:

  • series_obj (BaseHousePriceIndex) – Series object.

  • in_place (bool, optional) – If True, the revision is placed into the series object as a named list. Defaults to False.

  • smooth (bool, optional) – Smooth the index. If True, the revision is calculated based on the smoothed indices. Defaults to False.

Returns:

Revision and associated statistics

as object or DataFrame.

Return type:

BaseHousePriceIndex | pd.DataFrame

__call__(**kwargs)

Call self as a function.

__init__(**kwargs)

This Page