# ambforecast

> Ambulance forecast

## Docs

### API Reference

#### Data preparation
> Prepare and validate historic, holiday, and temperature data.

- [preprocessing.prepare_historic](https://ambmodels.github.io/ambforecast/reference/preprocessing.prepare_historic.html)
- [preprocessing.validate_historic](https://ambmodels.github.io/ambforecast/reference/preprocessing.validate_historic.html)
- [preprocessing.prepare_holidays](https://ambmodels.github.io/ambforecast/reference/preprocessing.prepare_holidays.html)
- [preprocessing.validate_holidays](https://ambmodels.github.io/ambforecast/reference/preprocessing.validate_holidays.html)
- [preprocessing.expand_holiday_windows](https://ambmodels.github.io/ambforecast/reference/preprocessing.expand_holiday_windows.html)
- [preprocessing.prepare_temp](https://ambmodels.github.io/ambforecast/reference/preprocessing.prepare_temp.html)
- [preprocessing.interpolate_temp](https://ambmodels.github.io/ambforecast/reference/preprocessing.interpolate_temp.html)
- [preprocessing.validate_temp](https://ambmodels.github.io/ambforecast/reference/preprocessing.validate_temp.html)

#### Data splitting
> Create train/test splits and rolling forecast origin samples.

- [splits.train_test_split](https://ambmodels.github.io/ambforecast/reference/splits.train_test_split.html)
- [splits.rolling_forecast_origin](https://ambmodels.github.io/ambforecast/reference/splits.rolling_forecast_origin.html)

#### ARIMA
> Configure and run ARIMA forecasts.

- [arima.ARIMAParams](https://ambmodels.github.io/ambforecast/reference/arima.ARIMAParams.html)
- [arima.arima](https://ambmodels.github.io/ambforecast/reference/arima.arima.html)

#### Prophet
> Configure and run Prophet forecasts.

- [prophet.ProphetRegressor](https://ambmodels.github.io/ambforecast/reference/prophet.ProphetRegressor.html)
- [prophet.ProphetParams](https://ambmodels.github.io/ambforecast/reference/prophet.ProphetParams.html)
- [prophet.prophet](https://ambmodels.github.io/ambforecast/reference/prophet.prophet.html)

#### Naive benchmark
> Configure and run Seasonal Naive forecasts.

- [naive.SNaiveParams](https://ambmodels.github.io/ambforecast/reference/naive.SNaiveParams.html)
- [naive.snaive](https://ambmodels.github.io/ambforecast/reference/naive.snaive.html)

#### Running forecasts
> Run individual, multi-area/metric, and cross-validation forecasts.

- [forecast.run_single_forecast](https://ambmodels.github.io/ambforecast/reference/forecast.run_single_forecast.html)
- [forecast.run_forecasts](https://ambmodels.github.io/ambforecast/reference/forecast.run_forecasts.html)
- [forecast.run_cross_validation](https://ambmodels.github.io/ambforecast/reference/forecast.run_cross_validation.html)

#### Ensembles
> Combine forecasts.

- [ensemble.ensemble](https://ambmodels.github.io/ambforecast/reference/ensemble.ensemble.html)

#### Forecast evaluation
> Calculate forecast accuracy measures.

- [errors.forecast_errors](https://ambmodels.github.io/ambforecast/reference/errors.forecast_errors.html)
- [errors.calculate_errors](https://ambmodels.github.io/ambforecast/reference/errors.calculate_errors.html)

#### Plotting
> Visualise results.

- [plot.plot_forecast](https://ambmodels.github.io/ambforecast/reference/plot.plot_forecast.html)
- [plot.plot_cross_validation](https://ambmodels.github.io/ambforecast/reference/plot.plot_cross_validation.html)
- [plot.plot_observed_against_forecast](https://ambmodels.github.io/ambforecast/reference/plot.plot_observed_against_forecast.html)
- [plot.plot_holiday_coverage](https://ambmodels.github.io/ambforecast/reference/plot.plot_holiday_coverage.html)
- [plot.plot_error_over_time](https://ambmodels.github.io/ambforecast/reference/plot.plot_error_over_time.html)
- [plot.plot_error_boxplot](https://ambmodels.github.io/ambforecast/reference/plot.plot_error_boxplot.html)