-
Notifications
You must be signed in to change notification settings - Fork 24
/
mkdocs.yml
151 lines (138 loc) · 5.72 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
site_name: Xopt
repo_url: https://github.com/xopt-org/Xopt
repo_name: xopt-org/Xopt
nav:
- Home: index.md
- Installation: installation.md
- Algorithms: algorithms.md
- Examples:
- Basics:
- examples/basic/xopt_basic.ipynb
- examples/basic/xopt_parallel.ipynb
- examples/basic/xopt_vocs.ipynb
- examples/basic/xopt_evaluator.ipynb
- examples/basic/xopt_generator.ipynb
- Bayesian:
- Gaussian Process Model Creation:
- Basic example: examples/gp_model_creation/model_creation.ipynb
- Bayesian Exploration:
- Bayesian Exploration: examples/bayes_exp/bayesian_exploration.ipynb
- Bayesian Exploration from yaml: examples/bayes_exp/bayesian_exploration_from_yaml.ipynb
- Single Objective Bayesian Optimization:
- Bayesian optimization tutorial: examples/single_objective_bayes_opt/bo_tutorial.ipynb
- Constrained optimization: examples/single_objective_bayes_opt/constrained_bo_tutorial.ipynb
- Log-transformed optimization: examples/single_objective_bayes_opt/log_transformed_tutorial.ipynb
- Upper confidence bound: examples/single_objective_bayes_opt/upper_confidence_bound.ipynb
- Custom GP models: examples/single_objective_bayes_opt/custom_model.ipynb
- Trust region: examples/single_objective_bayes_opt/turbo_tutorial.ipynb
- Interpolated optimization: examples/single_objective_bayes_opt/interpolate_tutorial.ipynb
- Multi-Fidelity: examples/single_objective_bayes_opt/multi_fidelity_simple.ipynb
- Time dependent upper confidence bound: examples/single_objective_bayes_opt/time_dependent_bo.ipynb
- Bayesian Algorithm Execution: examples/single_objective_bayes_opt/bax_tutorial.ipynb
- Bayesian Optimization with fixed features: examples/single_objective_bayes_opt/fixed_features.ipynb
- Custom objectives: examples/single_objective_bayes_opt/custom_objective.ipynb
- Heteroskedastic modeling: examples/single_objective_bayes_opt/heteroskedastic_noise_tutorial.ipynb
- Multi-Objective Bayesian Optimization:
- Expected hypervolume improvement: examples/multi_objective_bayes_opt/mobo.ipynb
- Multi-fidelity expected hypervolume improvement: examples/multi_objective_bayes_opt/multi_fidelity_mobo.ipynb
- Multi-generation gaussian process optimization: examples/multi_objective_bayes_opt/mggpo.ipynb
- Evolutionary:
- CNSGA: examples/cnsga/cnsga_tnk.ipynb
- SciPy:
- Nelder-Mead: examples/scipy/neldermead.ipynb
- Latin Hypercube: examples/scipy/latin_hypercube.ipynb
- Other:
- Extremum seeking: examples/es/extremum_seeking.ipynb
- RCDS: examples/rcds/rcds.ipynb
- API:
- Xopt: api/xopt.md
- Vocs: api/vocs.md
- Evaluator: api/evaluator.md
- Generators:
- Base generator class: api/generators.md
- Bayesian generators: api/generators/bayesian.md
- Genetic generators: api/generators/genetic.md
- SciPy generators: api/generators/scipy.md
theme:
icon:
repo: fontawesome/brands/github
name: material
custom_dir: docs/overrides
features:
- navigation.top
- navigation.tabs
- navigation.indexes
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/toggle-switch
name: Switch to light mode
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
extra_javascript:
# The following are for mathjax rendering of LaTeX formulas:
- javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
extra:
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/xopt-org/xopt
name: Xopt
extra_css:
- stylesheets/extra.css
plugins:
- search
- mkdocs-jupyter:
include_source: True
- mkdocstrings:
default_handler: python
handlers:
python:
options:
filters:
- "!^_" # exclude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
docstring_style: numpy
docstring_options:
ignore_init_summary: false
heading_level: 3
show_root_heading: true
show_root_toc_entry: true
show_root_full_path: true
show_root_members_full_path: false
show_object_full_path: true
show_category_heading: true
show_if_no_docstring: false
show_signature: true
signature_crossrefs: true
show_signature_annotations: false
separate_signature: true
line_length: 100
merge_init_into_class: true
show_source: true
show_bases: true
show_submodules: false
group_by_category: true
unwrap_annotated: true
import:
- https://docs.python.org/3/objects.inv
- https://docs.h5py.org/en/stable/objects.inv
- https://slaclab.github.io/lume-base/objects.inv
- https://lark-parser.readthedocs.io/en/latest/objects.inv
rendering:
show_source: true
show_root_heading: true