forked from pnkraemer/probdiffeq
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
158 lines (156 loc) · 5.66 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
---
theme:
name: material
features:
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.sections
- navigation.path
- navigation.indexes
# - toc.follow
- search.suggest
- search.highlight
palette:
# Palette toggle for light mode
- scheme: default
primary: white
accent: amber
toggle:
icon: material/eye
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/eye-outline
name: Switch to light mode
icon:
repo: fontawesome/brands/github
font:
text: Fira Sans
site_name: probdiffeq documentation
site_description: The documentation for the probdiffeq library.
site_author: Nicholas Krämer
strict: true
repo_url: https://github.com/pnkraemer/probdiffeq
repo_name: pnkraemer/probdiffeq
# Credit for a good amount of this setup: https://github.com/patrick-kidger/diffrax
extra_css: [_stylesheets/extra.css]
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences
- pymdownx.details
- pymdownx.snippets:
base_path: docs
- admonition
- toc:
permalink: ¤
toc_depth: 3
extra_javascript:
# Credit:
# https://github.com/patrick-kidger/diffrax
# and https://squidfunk.github.io/mkdocs-material/reference/mathjax/
- _javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
docstring_style: numpy
show_signature_annotations: true
- exclude:
glob:
- getting_started/easy_example.md
- getting_started/.ipynb_checkpoints/*
- examples_solver_config/*.md
- examples_solver_config/.ipynb_checkpoints/*
- examples_parameter_estimation/*.md
- examples_parameter_estimation/.ipynb_checkpoints/*
- benchmarks/hires/*.md
- benchmarks/hires/*.py
- benchmarks/hires/.ipynb_checkpoints/*
- benchmarks/pleiades/*.md
- benchmarks/pleiades/*.py
- benchmarks/pleiades/.ipynb_checkpoints/*
- benchmarks/vanderpol/*.md
- benchmarks/vanderpol/*.py
- benchmarks/vanderpol/.ipynb_checkpoints/*
- benchmarks/lotkavolterra/*.md
- benchmarks/lotkavolterra/*.py
- benchmarks/lotkavolterra/.ipynb_checkpoints/*
- benchmarks/taylor_pleiades/*.md
- benchmarks/taylor_pleiades/*.py
- benchmarks/taylor_pleiades/.ipynb_checkpoints/*
- benchmarks/taylor_fitzhughnagumo/*.md
- benchmarks/taylor_fitzhughnagumo/*.py
- benchmarks/taylor_fitzhughnagumo/.ipynb_checkpoints/*
- benchmarks/taylor_node/*.md
- benchmarks/taylor_node/*.py
- benchmarks/taylor_node/.ipynb_checkpoints/*
- mkdocs-jupyter
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/@pnkraemer
name: Nico
generator: false
nav:
- Quickstart: index.md
- GETTING STARTED:
- An easy example: getting_started/easy_example.ipynb
- Transitioning from other packages: getting_started/transitioning_from_other_packages.md
- Choosing a solver: getting_started/choosing_a_solver.md
- Troubleshooting: getting_started/troubleshooting.md
- SOLVER CONFIGURATION:
- examples_solver_config/conditioning-on-zero-residual.ipynb
- examples_solver_config/posterior_uncertainties.ipynb
- examples_solver_config/dynamic_output_scales.ipynb
- examples_solver_config/smoothing.ipynb
- examples_solver_config/second_order_problems.ipynb
- PARAMETER ESTIMATION:
- Parameter estimation with Optax: examples_parameter_estimation/physics_enhanced_regression_1.ipynb
- Parameter estimation with BlackJAX: examples_parameter_estimation/physics_enhanced_regression_2.ipynb
- Neural ODEs with Optax: examples_parameter_estimation/neural_ode.ipynb
- API DOCUMENTATION:
- ivpsolve: api_docs/ivpsolve.md
- adaptive: api_docs/adaptive.md
- controls: api_docs/controls.md
- timestep: api_docs/timestep.md
- impl: api_docs/impl.md
- solvers:
- strategies:
- components:
- priors: api_docs/solvers/strategies/components/priors.md
- corrections: api_docs/solvers/strategies/components/corrections.md
- cubature: api_docs/solvers/strategies/components/cubature.md
- strategy: api_docs/solvers/strategies/strategy.md
- filters: api_docs/solvers/strategies/filters.md
- smoothers: api_docs/solvers/strategies/smoothers.md
- fixedpoint: api_docs/solvers/strategies/fixedpoint.md
- discrete: api_docs/solvers/strategies/discrete.md
- calibrated: api_docs/solvers/calibrated.md
- uncalibrated: api_docs/solvers/uncalibrated.md
- solution: api_docs/solvers/solution.md
- markov: api_docs/solvers/markov.md
- taylor:
- affine: api_docs/taylor/affine.md
- autodiff: api_docs/taylor/autodiff.md
- estim: api_docs/taylor/estim.md
- DEVELOPER DOCUMENTATION:
- Changelog: dev_docs/changelog.md
- dev_docs/public_api.md
- dev_docs/creating_example_notebook.md
- dev_docs/continuous_integration.md
- BENCHMARKS:
- benchmarks/lotkavolterra/plot.ipynb
- benchmarks/pleiades/plot.ipynb
- benchmarks/hires/plot.ipynb
- benchmarks/vanderpol/plot.ipynb
- benchmarks/taylor_pleiades/plot.ipynb
- benchmarks/taylor_fitzhughnagumo/plot.ipynb
- benchmarks/taylor_node/plot.ipynb