-
Notifications
You must be signed in to change notification settings - Fork 51
/
mkdocs.yml
135 lines (126 loc) · 4.18 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
site_name: GPJax
site_description: The documentation for the GPJax software library.
site_url: https://docs.jaxgaussianprocesses.com/
repo_url: https://github.com/JaxGaussianProcesses/GPJax
repo_name: JaxGaussianProcesses/GPJax
# edit_uri: ""
nav:
- 🏡 Home: index.md
- Getting started:
- 🛠️ Installation: installation.md
- 🎨 Design principles: design.md
- 🤝 Contributing: contributing.md
- 🔪 Sharp bits: sharp_bits.md
- 📎 JAX 101 [External]: https://jax.readthedocs.io/en/latest/jax-101/index.html
- 💡 Background:
- Intro to GPs: _examples/intro_to_gps.md
- Intro to Kernels: _examples/intro_to_kernels.md
- 🎓 Tutorials:
- Regression: _examples/regression.md
- Classification: _examples/classification.md
- Poisson regression: _examples/poisson.md
- Barycentres: _examples/barycentres.md
- Deep kernel learning: _examples/deep_kernels.md
- Graph kernels: _examples/graph_kernels.md
- Sparse GPs: _examples/uncollapsed_vi.md
- Stochastic sparse GPs: _examples/collapsed_vi.md
- Bayesian Optimisation: _examples/bayesian_optimisation.md
- Decision Making: _examples/decision_making.md
- Multi-output GPs for Ocean Modelling: _examples/oceanmodelling.md
- 📖 Guides for customisation:
- Kernels: _examples/constructing_new_kernels.md
- Likelihoods: _examples/likelihoods_guide.md
- Model Guide: _examples/backend.md
- UCI regression: _examples/yacht.md
# - 💻 Raw tutorial code: give_me_the_code.md
- Community:
- 👥 Code of conduct: CODE_OF_CONDUCT.md
- 📜 Governance: GOVERNANCE.md
- 📨 Contact: https://jaxgaussianprocesses.com/contact/
- 📕 Reference: api/
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top # Show a back to top button
- content.code.copy
- search.suggest # Show search suggestions
- search.highlight # Highlight search results in results
- content.code.annotate # Allow individual lines of code to be annotated
icon:
repo: fontawesome/brands/github
logo: static/favicon.ico
favicon: static/favicon.ico
markdown_extensions:
- admonition
- markdown_katex:
no_inline_svg: True
insert_fonts_css: True
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
- toc:
permalink: ''
toc_depth: 4
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
- search
- gen-files:
scripts:
- docs/scripts/gen_pages.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
paths: ["gpjax"]
rendering:
show_symbol_type_toc: true
show_signature_annotations: true
options:
members_order: source
inherited_members: true
show_source: false
show_root_heading: false
show_root_toc_entry: false
allow_inspection: false
docstring_style: "google"
docstring_section_style: "list"
merge_init_into_class: true
separate_signature: true
filters:
- "!^_" # filter private members
- "!^__"
- "^__init__$" # except...
- "^__call__$"
- "^__*add__$"
- "^__*mul__$"
docstring_options:
ignore_init_summary: true
extra:
analytics:
provider: google
property: G-L15440C0N0
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css
- stylesheets/extra.css
- stylesheets/permalinks.css
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js
- javascripts/katex.js