User Guide

Getting started

The following guides cover how to get started with a pyramid distribution. The easiest solution is simply installing from PyPi, but if you’d like to contribute you’ll need to be able to build from source.

• 1. About the project
  • 1.1. How it works
    • 1.1.1. How auto_arima works
  • 1.2. Feedback
• 2. Setup
  • 2.1. Install from PyPi
  • 2.2. Build from source
• 3. Pyramid Quickstart
  • 3.1. Auto-ARIMA example
• 4. Serializing your ARIMA models
  • 4.1. Intricacies of ARIMA serialization
    • 4.1.1. The serialization process
    • 4.1.2. The de-serialization process
• 5. Refreshing your ARIMA models
  • 5.1. Adding observations to your model
• 6. Tips to using auto_arima
  • 6.1. Understand p, d, and q
    • 6.1.1. Understanding differencing
  • 6.2. Enforcing stationarity
  • 6.3. Understand P, D, Q and m
    • 6.3.1. Estimating the seasonal differencing term, D
    • 6.3.2. Setting m
  • 6.4. Parallel vs. stepwise
• 7. Toy time-series datasets
  • 7.1. Heartrate
  • 7.2. Lynx
  • 7.3. Wineind
  • 7.4. Woolyrnq
• 8. Contributing to Pyramid
  • 8.1. How to contribute
  • 8.2. Pull Request Checklist
  • 8.3. Filing bugs
• 9. Contributors

API reference

The API Reference covers documentation and examples of each of the Pyramid package’s submodules.