forked from skforecast/skforecast
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
105 lines (99 loc) · 3.65 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: Skforecast Docs
extra_css:
- stylesheets/extra.css
repo_url: https://github.com/JoaquinAmatRodrigo/skforecast
site_url: https://joaquinamatrodrigo.github.io/skforecast/
site_description: Python library that eases using scikit-learn regressors as multi-step forecasters. It also works with any regressor compatible with the scikit-learn API (XGBoost, LightGBM, Ranger...).
site_author: Joaquin Amat Rodrigo
use_directory_urls: false
nav:
- Home:
- Welcome to skforecast: README.md
- Quick start: quick-start/introduction-forecasting.md
- User Guides: user_guides/input-data.ipynb
- Examples and tutorials: examples/examples.md
- API Reference: api/ForecasterAutoreg.md
- Releases: releases/releases.md
- Quick start:
- Introduction to forecasting: quick-start/introduction-forecasting.md
- Quick start skforecast: user_guides/quick-start-skforecast.ipynb
- User Guides:
- Input data: user_guides/input-data.ipynb
- Recursive multi-step forecasting: user_guides/autoregresive-forecaster.ipynb
- Direct multi-step forecasting: user_guides/direct-multi-step-forecasting.ipynb
- Exogenous variables: user_guides/autoregresive-forecaster-exogenous.ipynb
- Custom predictors: user_guides/custom-predictors.ipynb
- Backtesting forecaster: user_guides/backtesting.ipynb
- Grid search forecaster: user_guides/grid-search-forecaster.ipynb
- Scikit-learn Pipeline: user_guides/sklearn-pipeline.ipynb
- Prediction intervals: user_guides/prediction-intervals.ipynb
- Feature importance: user_guides/feature-importance.ipynb
- Forecasting with XGBoost: user_guides/forecasting-xgboost.ipynb
- Save and load forecaster: user_guides/save-load-forecaster.ipynb
- Forecaster in production: user_guides/forecaster-in-production.ipynb
- Grid search SARIMAX and ARIMA models: user_guides/grid-search-sarimax-arima.ipynb
- Backtesting SARIMAX and ARIMA models: user_guides/backtesting-sarimax-arima.ipynb
- Examples and tutorials:
- Examples and tutorials: examples/examples.md
- API Reference:
- ForecasterAutoreg: api/ForecasterAutoreg.md
- ForecasterAutoregCustom: api/ForecasterAutoregCustom.md
- ForecasterAutoregDirect: api/ForecasterAutoregDirect.md
- model_selection: api/model_selection.md
- model_selection_statsmodels: api/model_selection_statsmodels.md
- Releases: releases/releases.md
plugins:
- mkdocstrings:
handlers:
python:
selection:
docstring_style: numpy
filters:
- "!^_" # exclude all members starting with _
rendering:
show_root_heading: yes
docstring_section_style: table
- mkdocs-jupyter:
include_source: False
ignore_h1_titles: True
include_source: True
- search
copyright:
theme:
name: material
custom_dir: docs/overrides
font:
text: Ubuntu
code: Ubuntu Mono
logo: img/logo_skforecast_white_no_background.png
highlightjs: true
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.top
palette:
primary: deep purple
accent: light blue
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- codehilite
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.tabbed
- pymdownx.highlight:
use_pygments: true
linenums: true
- pymdownx.superfences
- pymdownx.magiclink
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
permalink: true
extra:
version:
provider: mike