Skip to content

Commit 1dd8bb8

Browse files
committed
docs: page headers made consistent, ranked batch query page removed from index.rst (the page is not fully written yet)
1 parent 29153e8 commit 1dd8bb8

8 files changed

Lines changed: 323 additions & 461 deletions

File tree

docs/source/content/examples/Keras-integration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Bringing your Keras models to modAL workflows
2-
=============================================
1+
Keras models in modAL workflows
2+
===============================
33

44
Thanks for the scikit-learn API of Keras, you can seamlessly integrate Keras models into your modAL workflow. In this tutorial, we shall quickly introduce how to use the scikit-learn API of Keras and we are going to see how to do active learning with it. More details on the Keras scikit-learn API `can be found here <https://keras.io/scikit-learn-api/>`__.
55

docs/source/content/examples/active_regression.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Active regression with Gaussian processes\n",
7+
"# Active regression\n",
88
"In this example, we are going to demonstrate how can the ActiveLearner be used for active regression using Gaussian processes. Since Gaussian processes provide a way to quantify uncertainty of the predictions as the covariance function of the process, they can be used in an active learning setting."
99
]
1010
},
@@ -229,7 +229,7 @@
229229
"name": "python",
230230
"nbconvert_exporter": "python",
231231
"pygments_lexer": "ipython3",
232-
"version": "3.6.6"
232+
"version": "3.6.5"
233233
}
234234
},
235235
"nbformat": 4,

docs/source/content/examples/ensemble_regression.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"cell_type": "markdown",
55
"metadata": {},
66
"source": [
7-
"# Active regression with Committee\n",
7+
"# Ensemble regression\n",
88
"With an ensemble of regressors, the standard deviation of the predictions at a given point can be thought of as a measure of disagreement. This can be used for active regression. In the following example, we are going to see how can it be done using the CommitteeRegressor class.\n",
99
"\n",
1010
"The executable script for this example can be [found here!](https://github.com/cosmic-cortex/modAL/blob/master/examples/ensemble_regression.py)\n",
@@ -234,7 +234,7 @@
234234
"name": "python",
235235
"nbconvert_exporter": "python",
236236
"pygments_lexer": "ipython3",
237-
"version": "3.6.6"
237+
"version": "3.6.5"
238238
}
239239
},
240240
"nbformat": 4,

docs/source/content/examples/extending_modal.ipynb

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

docs/source/content/overview/Extending-modAL.ipynb

Lines changed: 302 additions & 0 deletions
Large diffs are not rendered by default.

docs/source/content/overview/Extending-modAL.rst

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

docs/source/content/overview/modAL-in-a-nutshell.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ strategy is as easy as the following.
9999
)
100100
101101
For more details on how to implement your custom strategies, visit the
102-
page :ref:`Extending-modAL`!
102+
page `Extending modAL <content/overview/Extending-modAL.ipynb>`_!
103103

104104
An example with active regression
105105
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/index.rst

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,7 @@ strategy is as easy as the following.
9595
X_training=X_training, y_training=y_training
9696
)
9797
98-
For more details on how to implement your custom strategies, visit the
99-
page :ref:`Extending-modAL`!
98+
For more details on how to implement your custom strategies, visit the page `Extending modAL <content/overview/Extending-modAL.ipynb>`_!
10099

101100

102101
An example with active regression
@@ -195,27 +194,26 @@ Danka <https://www.tivadardanka.com>`__ (aka
195194
:maxdepth: 1
196195
:caption: Overview
197196

198-
modAL in a nutshell <content/overview/modAL-in-a-nutshell>
199-
Installation <content/overview/Installation>
200-
Extending modAL <content/overview/Extending-modAL>
197+
content/overview/modAL-in-a-nutshell
198+
content/overview/Installation
199+
content/overview/Extending-modAL
201200

202201
.. toctree::
203202
:maxdepth: 1
204203
:caption: Models
205204

206-
ActiveLearner <content/models/ActiveLearner>
207-
BayesianOptimizer <content/models/BayesianOptimizer>
208-
Committee <content/models/Committee>
209-
CommitteeRegressor <content/models/CommitteeRegressor>
205+
content/models/ActiveLearner
206+
content/models/BayesianOptimizer
207+
content/models/Committee
208+
content/models/CommitteeRegressor
210209

211210
.. toctree::
212211
:maxdepth: 1
213212
:caption: Query strategies
214213

215-
Acquisition functions <content/query_strategies/Acquisition-functions>
216-
Uncertainty sampling <content/query_strategies/Uncertainty-sampling>
217-
Disagreement sampling <content/query_strategies/Disagreement-sampling>
218-
content/query_strategies/Ranked-batch-queries
214+
content/query_strategies/Acquisition-functions
215+
content/query_strategies/Uncertainty-sampling
216+
content/query_strategies/Disagreement-sampling
219217

220218
.. toctree::
221219
:maxdepth: 1
@@ -224,13 +222,12 @@ Danka <https://www.tivadardanka.com>`__ (aka
224222
content/examples/pool-based_sampling
225223
content/examples/ranked_batch_mode
226224
content/examples/Stream-based-sampling
227-
Active regression <content/examples/active_regression>
228-
Ensemble regression <content/examples/ensemble_regression>
225+
content/examples/active_regression
226+
content/examples/ensemble_regression
229227
content/examples/bayesian_optimization
230228
content/examples/Query-by-committee
231229
content/examples/Bootstrapping-and-bagging
232-
content/examples/extending_modal
233-
Keras integration <content/examples/Keras-integration>
230+
content/examples/Keras-integration
234231

235232
.. toctree::
236233
:glob:

0 commit comments

Comments
 (0)