Skip to content

Commit b0c9d1f

Browse files
docs: refactor first half of modAL.models
1 parent fdf6bb0 commit b0c9d1f

9 files changed

Lines changed: 732 additions & 1211 deletions

File tree

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
'sphinx.ext.mathjax',
4444
'sphinx.ext.viewcode',
4545
'sphinx.ext.githubpages',
46+
'sphinx.ext.napoleon',
4647
'nbsphinx'
4748
]
4849

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
models
2+
======
3+
4+
modAL models
5+
6+
7+
.. autoclass:: modAL.models.BaseLearner
8+
:members:
9+
10+
.. autoclass:: modAL.models.ActiveLearner
11+
:members:
12+
13+
.. autoclass:: modAL.models.BayesianOptimizer
14+
:members:

docs/source/content/examples/Active-regression.rst

Lines changed: 0 additions & 74 deletions
This file was deleted.

docs/source/content/examples/Bayesian-optimization.rst

Lines changed: 0 additions & 86 deletions
This file was deleted.

docs/source/content/examples/Ensemble-regression.rst

Lines changed: 0 additions & 81 deletions
This file was deleted.

docs/source/content/examples/Pool-based-sampling.rst

Lines changed: 0 additions & 78 deletions
This file was deleted.

docs/source/content/examples/custom_query_strategies.ipynb renamed to docs/source/content/examples/extending_modal.ipynb

File renamed without changes.

docs/source/index.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -215,20 +215,26 @@ Danka <https://www.tivadardanka.com>`__ (aka
215215
Acquisition functions <content/query_strategies/Acquisition-functions>
216216
Uncertainty sampling <content/query_strategies/Uncertainty-sampling>
217217
Disagreement sampling <content/query_strategies/Disagreement-sampling>
218+
content/query_strategies/Ranked-batch-queries
218219

219220
.. toctree::
220221
:maxdepth: 1
221222
:caption: Examples
222223

223-
Pool-based sampling <content/examples/pool-based_sampling>
224-
Stream-based sampling <content/examples/Stream-based-sampling>
224+
content/examples/pool-based_sampling
225+
content/examples/ranked_batch_mode
226+
content/examples/Stream-based-sampling
225227
Active regression <content/examples/active_regression>
226228
Ensemble regression <content/examples/ensemble_regression>
227-
Bayesian optimization <content/examples/bayesian_optimization>
228-
Query by committee <content/examples/Query-by-committee>
229-
Bootstrapping and bagging <content/examples/Bootstrapping-and-bagging>
229+
content/examples/bayesian_optimization
230+
content/examples/Query-by-committee
231+
content/examples/Bootstrapping-and-bagging
232+
content/examples/extending_modal
230233
Keras integration <content/examples/Keras-integration>
231234

232235
.. toctree::
236+
:glob:
233237
:maxdepth: 1
234238
:caption: API reference
239+
240+
content/apireference/*

0 commit comments

Comments
 (0)