API Reference

This page contains detailed API documentation for all public classes and functions in hpiPy.

API Modules

• Price Index
  • hpipy.price_index.RepeatTransactionIndex
  • hpipy.price_index.HedonicIndex
  • hpipy.extensions.RandomForestIndex
  • hpipy.extensions.NeuralNetworkIndex
• Price Model
  • hpipy.price_model.RepeatTransactionModel
  • hpipy.price_model.HedonicModel
  • hpipy.extensions.RandomForestModel
  • hpipy.extensions.NeuralNetworkModel
• Transaction Data
  • hpipy.trans_data.TransactionData
• Period Table
  • hpipy.period_table.PeriodTable
• Time Matrix
  • hpipy.time_matrix.TimeMatrixMixin
• Evaluation Metrics
  • hpipy.utils.metrics.accuracy
  • hpipy.utils.metrics.volatility
  • hpipy.utils.metrics.revision
  • hpipy.utils.metrics.series_accuracy
  • hpipy.utils.metrics.series_volatility
• Plotting
  • hpipy.utils.plotting.plot_index
  • hpipy.utils.plotting.plot_index_accuracy
  • hpipy.utils.plotting.plot_index_volatility
  • hpipy.utils.plotting.plot_series
  • hpipy.utils.plotting.plot_series_accuracy
  • hpipy.utils.plotting.plot_series_volatility
  • hpipy.utils.plotting.plot_series_revision
• Datasets
  • hpipy.datasets.load_ex_sales
  • hpipy.datasets.load_seattle_sales