Skip to content

Commit 1fec1bb

Browse files
committed
Rebuild dev docs at master=213a24c
1 parent cbe8fd9 commit 1fec1bb

File tree

233 files changed

+1477
-1477
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

233 files changed

+1477
-1477
lines changed
19.6 KB
Loading

dev/_sources/modules/classes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1031,7 +1031,7 @@ See the :ref:`metrics` section of the user guide for further details.
10311031
:no-members:
10321032
:no-inherited-members:
10331033

1034-
**User guide:** See the :ref:`neural_network` section for further details.
1034+
**User guide:** See the :ref:`neural_networks_supervised` and :ref:`neural_networks_unsupervised` sections for further details.
10351035

10361036
.. currentmodule:: sklearn
10371037

dev/_sources/modules/neural_networks_supervised.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _neural_network:
1+
.. _neural_networks_supervised:
22

33
==================================
44
Neural network models (supervised)

dev/_sources/modules/neural_networks_unsupervised.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _neural_network:
1+
.. _neural_networks_unsupervised:
22

33
====================================
44
Neural network models (unsupervised)

dev/modules/classes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1889,7 +1889,7 @@ <h3>Multiclass and multilabel classification strategies<a class="headerlink" hre
18891889
<span id="sklearn-neural-network-neural-network-models"></span><span id="neural-network-ref"></span><h2><a class="reference internal" href="#module-sklearn.neural_network" title="sklearn.neural_network"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.neural_network</span></tt></a>: Neural network models<a class="headerlink" href="#module-sklearn.neural_network" title="Permalink to this headline"></a></h2>
18901890
<p>The <a class="reference internal" href="#module-sklearn.neural_network" title="sklearn.neural_network"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.neural_network</span></tt></a> module includes models based on neural
18911891
networks.</p>
1892-
<p><strong>User guide:</strong> See the <a class="reference internal" href="neural_networks_unsupervised.html#neural-network"><em>Neural network models (unsupervised)</em></a> section for further details.</p>
1892+
<p><strong>User guide:</strong> See the <a class="reference internal" href="neural_networks_supervised.html#neural-networks-supervised"><em>Neural network models (supervised)</em></a> and <a class="reference internal" href="neural_networks_unsupervised.html#neural-networks-unsupervised"><em>Neural network models (unsupervised)</em></a> sections for further details.</p>
18931893
<table border="1" class="longtable docutils">
18941894
<colgroup>
18951895
<col width="10%" />

dev/modules/generated/sklearn.base.BaseEstimator.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
<h1><a class="reference internal" href="../classes.html#module-sklearn.base" title="sklearn.base"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.base</span></tt></a>.BaseEstimator<a class="headerlink" href="#sklearn-base-baseestimator" title="Permalink to this headline"></a></h1>
173173
<dl class="class">
174174
<dt id="sklearn.base.BaseEstimator">
175-
<em class="property">class </em><tt class="descclassname">sklearn.base.</tt><tt class="descname">BaseEstimator</tt><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L169"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator" title="Permalink to this definition"></a></dt>
175+
<em class="property">class </em><tt class="descclassname">sklearn.base.</tt><tt class="descname">BaseEstimator</tt><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L169"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator" title="Permalink to this definition"></a></dt>
176176
<dd><p>Base class for all estimators in scikit-learn</p>
177177
<p class="rubric">Notes</p>
178178
<p>All estimators should specify all the parameters that can be set
@@ -201,7 +201,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.base" tit
201201

202202
<dl class="method">
203203
<dt id="sklearn.base.BaseEstimator.get_params">
204-
<tt class="descname">get_params</tt><big>(</big><em>deep=True</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L206"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.get_params" title="Permalink to this definition"></a></dt>
204+
<tt class="descname">get_params</tt><big>(</big><em>deep=True</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L206"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.get_params" title="Permalink to this definition"></a></dt>
205205
<dd><p>Get parameters for this estimator.</p>
206206
<table class="docutils field-list" frame="void" rules="none">
207207
<col class="field-name" />
@@ -226,7 +226,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.base" tit
226226

227227
<dl class="method">
228228
<dt id="sklearn.base.BaseEstimator.set_params">
229-
<tt class="descname">set_params</tt><big>(</big><em>**params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L243"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.set_params" title="Permalink to this definition"></a></dt>
229+
<tt class="descname">set_params</tt><big>(</big><em>**params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L243"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.set_params" title="Permalink to this definition"></a></dt>
230230
<dd><p>Set the parameters of this estimator.</p>
231231
<p>The method works on simple estimators as well as on nested objects
232232
(such as pipelines). The former have parameters of the form

dev/modules/generated/sklearn.base.TransformerMixin.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
<h1><a class="reference internal" href="../classes.html#module-sklearn.base" title="sklearn.base"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.base</span></tt></a>.TransformerMixin<a class="headerlink" href="#sklearn-base-transformermixin" title="Permalink to this headline"></a></h1>
173173
<dl class="class">
174174
<dt id="sklearn.base.TransformerMixin">
175-
<em class="property">class </em><tt class="descclassname">sklearn.base.</tt><tt class="descname">TransformerMixin</tt><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L435"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.TransformerMixin" title="Permalink to this definition"></a></dt>
175+
<em class="property">class </em><tt class="descclassname">sklearn.base.</tt><tt class="descname">TransformerMixin</tt><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L435"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.TransformerMixin" title="Permalink to this definition"></a></dt>
176176
<dd><p>Mixin class for all transformers in scikit-learn.</p>
177177
<p class="rubric">Methods</p>
178178
<table border="1" class="longtable docutils">
@@ -194,7 +194,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.base" tit
194194

195195
<dl class="method">
196196
<dt id="sklearn.base.TransformerMixin.fit_transform">
197-
<tt class="descname">fit_transform</tt><big>(</big><em>X</em>, <em>y=None</em>, <em>**fit_params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L438"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.TransformerMixin.fit_transform" title="Permalink to this definition"></a></dt>
197+
<tt class="descname">fit_transform</tt><big>(</big><em>X</em>, <em>y=None</em>, <em>**fit_params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L438"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.TransformerMixin.fit_transform" title="Permalink to this definition"></a></dt>
198198
<dd><p>Fit to data, then transform it.</p>
199199
<p>Fits transformer to X and y with optional parameters fit_params
200200
and returns a transformed version of X.</p>

dev/modules/generated/sklearn.calibration.CalibratedClassifierCV.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
<h1><a class="reference internal" href="../classes.html#module-sklearn.calibration" title="sklearn.calibration"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.calibration</span></tt></a>.CalibratedClassifierCV<a class="headerlink" href="#sklearn-calibration-calibratedclassifiercv" title="Permalink to this headline"></a></h1>
173173
<dl class="class">
174174
<dt id="sklearn.calibration.CalibratedClassifierCV">
175-
<em class="property">class </em><tt class="descclassname">sklearn.calibration.</tt><tt class="descname">CalibratedClassifierCV</tt><big>(</big><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/calibration.py#L29"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV" title="Permalink to this definition"></a></dt>
175+
<em class="property">class </em><tt class="descclassname">sklearn.calibration.</tt><tt class="descname">CalibratedClassifierCV</tt><big>(</big><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/calibration.py#L29"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV" title="Permalink to this definition"></a></dt>
176176
<dd><p>Probability calibration with isotonic regression or sigmoid.</p>
177177
<p>With this class, the base_estimator is fit on the train set of the
178178
cross-validation generator and the test set is used for calibration.
@@ -237,31 +237,31 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
237237
</tbody>
238238
</table>
239239
<p class="rubric">References</p>
240-
<table class="docutils citation" frame="void" id="r1" rules="none">
240+
<table class="docutils citation" frame="void" id="r105" rules="none">
241241
<colgroup><col class="label" /><col /></colgroup>
242242
<tbody valign="top">
243-
<tr><td class="label"><a class="fn-backref" href="#id1">[R1]</a></td><td>Obtaining calibrated probability estimates from decision trees
243+
<tr><td class="label"><a class="fn-backref" href="#id1">[R105]</a></td><td>Obtaining calibrated probability estimates from decision trees
244244
and naive Bayesian classifiers, B. Zadrozny &amp; C. Elkan, ICML 2001</td></tr>
245245
</tbody>
246246
</table>
247-
<table class="docutils citation" frame="void" id="r2" rules="none">
247+
<table class="docutils citation" frame="void" id="r106" rules="none">
248248
<colgroup><col class="label" /><col /></colgroup>
249249
<tbody valign="top">
250-
<tr><td class="label"><a class="fn-backref" href="#id2">[R2]</a></td><td>Transforming Classifier Scores into Accurate Multiclass
250+
<tr><td class="label"><a class="fn-backref" href="#id2">[R106]</a></td><td>Transforming Classifier Scores into Accurate Multiclass
251251
Probability Estimates, B. Zadrozny &amp; C. Elkan, (KDD 2002)</td></tr>
252252
</tbody>
253253
</table>
254-
<table class="docutils citation" frame="void" id="r3" rules="none">
254+
<table class="docutils citation" frame="void" id="r107" rules="none">
255255
<colgroup><col class="label" /><col /></colgroup>
256256
<tbody valign="top">
257-
<tr><td class="label"><a class="fn-backref" href="#id3">[R3]</a></td><td>Probabilistic Outputs for Support Vector Machines and Comparisons to
257+
<tr><td class="label"><a class="fn-backref" href="#id3">[R107]</a></td><td>Probabilistic Outputs for Support Vector Machines and Comparisons to
258258
Regularized Likelihood Methods, J. Platt, (1999)</td></tr>
259259
</tbody>
260260
</table>
261-
<table class="docutils citation" frame="void" id="r4" rules="none">
261+
<table class="docutils citation" frame="void" id="r108" rules="none">
262262
<colgroup><col class="label" /><col /></colgroup>
263263
<tbody valign="top">
264-
<tr><td class="label"><a class="fn-backref" href="#id4">[R4]</a></td><td>Predicting Good Probabilities with Supervised Learning,
264+
<tr><td class="label"><a class="fn-backref" href="#id4">[R108]</a></td><td>Predicting Good Probabilities with Supervised Learning,
265265
A. Niculescu-Mizil &amp; R. Caruana, ICML 2005</td></tr>
266266
</tbody>
267267
</table>
@@ -294,12 +294,12 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
294294
</table>
295295
<dl class="method">
296296
<dt id="sklearn.calibration.CalibratedClassifierCV.__init__">
297-
<tt class="descname">__init__</tt><big>(</big><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/calibration.py#L98"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.__init__" title="Permalink to this definition"></a></dt>
297+
<tt class="descname">__init__</tt><big>(</big><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/calibration.py#L98"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.__init__" title="Permalink to this definition"></a></dt>
298298
<dd></dd></dl>
299299

300300
<dl class="method">
301301
<dt id="sklearn.calibration.CalibratedClassifierCV.fit">
302-
<tt class="descname">fit</tt><big>(</big><em>X</em>, <em>y</em>, <em>sample_weight=None</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/calibration.py#L103"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.fit" title="Permalink to this definition"></a></dt>
302+
<tt class="descname">fit</tt><big>(</big><em>X</em>, <em>y</em>, <em>sample_weight=None</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/calibration.py#L103"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.fit" title="Permalink to this definition"></a></dt>
303303
<dd><p>Fit the calibrated model</p>
304304
<table class="docutils field-list" frame="void" rules="none">
305305
<col class="field-name" />
@@ -331,7 +331,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
331331

332332
<dl class="method">
333333
<dt id="sklearn.calibration.CalibratedClassifierCV.get_params">
334-
<tt class="descname">get_params</tt><big>(</big><em>deep=True</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L206"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.get_params" title="Permalink to this definition"></a></dt>
334+
<tt class="descname">get_params</tt><big>(</big><em>deep=True</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L206"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.get_params" title="Permalink to this definition"></a></dt>
335335
<dd><p>Get parameters for this estimator.</p>
336336
<table class="docutils field-list" frame="void" rules="none">
337337
<col class="field-name" />
@@ -356,7 +356,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
356356

357357
<dl class="method">
358358
<dt id="sklearn.calibration.CalibratedClassifierCV.predict">
359-
<tt class="descname">predict</tt><big>(</big><em>X</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/calibration.py#L216"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.predict" title="Permalink to this definition"></a></dt>
359+
<tt class="descname">predict</tt><big>(</big><em>X</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/calibration.py#L216"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.predict" title="Permalink to this definition"></a></dt>
360360
<dd><p>Predict the target of new samples. Can be different from the
361361
prediction of the uncalibrated classifier.</p>
362362
<table class="docutils field-list" frame="void" rules="none">
@@ -381,7 +381,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
381381

382382
<dl class="method">
383383
<dt id="sklearn.calibration.CalibratedClassifierCV.predict_proba">
384-
<tt class="descname">predict_proba</tt><big>(</big><em>X</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/calibration.py#L186"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.predict_proba" title="Permalink to this definition"></a></dt>
384+
<tt class="descname">predict_proba</tt><big>(</big><em>X</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/calibration.py#L186"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.predict_proba" title="Permalink to this definition"></a></dt>
385385
<dd><p>Posterior probabilities of classification</p>
386386
<p>This function returns posterior probabilities of classification
387387
according to each class on an array of test vectors X.</p>
@@ -407,7 +407,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
407407

408408
<dl class="method">
409409
<dt id="sklearn.calibration.CalibratedClassifierCV.score">
410-
<tt class="descname">score</tt><big>(</big><em>X</em>, <em>y</em>, <em>sample_weight=None</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L292"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.score" title="Permalink to this definition"></a></dt>
410+
<tt class="descname">score</tt><big>(</big><em>X</em>, <em>y</em>, <em>sample_weight=None</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L292"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.score" title="Permalink to this definition"></a></dt>
411411
<dd><p>Returns the mean accuracy on the given test data and labels.</p>
412412
<p>In multi-label classification, this is the subset accuracy
413413
which is a harsh metric since you require for each sample that
@@ -442,7 +442,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
442442

443443
<dl class="method">
444444
<dt id="sklearn.calibration.CalibratedClassifierCV.set_params">
445-
<tt class="descname">set_params</tt><big>(</big><em>**params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/b4adafe/sklearn/base.py#L243"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.set_params" title="Permalink to this definition"></a></dt>
445+
<tt class="descname">set_params</tt><big>(</big><em>**params</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/213a24c/sklearn/base.py#L243"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.set_params" title="Permalink to this definition"></a></dt>
446446
<dd><p>Set the parameters of this estimator.</p>
447447
<p>The method works on simple estimators as well as on nested objects
448448
(such as pipelines). The former have parameters of the form

0 commit comments

Comments
 (0)