Skip to content

Commit ed6b69a

Browse files
committed
Rebuild dev docs at master=85223b9
1 parent 989053a commit ed6b69a

File tree

220 files changed

+1440
-1440
lines changed

Some content is hidden

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

220 files changed

+1440
-1440
lines changed

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"><code class="xref py py-mod docutils literal"><span class="pre">sklearn.base</span></code></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><code class="descclassname">sklearn.base.</code><code class="descname">BaseEstimator</code><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L162"><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><code class="descclassname">sklearn.base.</code><code class="descname">BaseEstimator</code><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L162"><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-
<code class="descname">get_params</code><span class="sig-paren">(</span><em>deep=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L199"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.get_params" title="Permalink to this definition"></a></dt>
204+
<code class="descname">get_params</code><span class="sig-paren">(</span><em>deep=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L199"><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-
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L236"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.BaseEstimator.set_params" title="Permalink to this definition"></a></dt>
229+
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L236"><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"><code class="xref py py-mod docutils literal"><span class="pre">sklearn.base</span></code></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><code class="descclassname">sklearn.base.</code><code class="descname">TransformerMixin</code><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L428"><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><code class="descclassname">sklearn.base.</code><code class="descname">TransformerMixin</code><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L428"><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-
<code class="descname">fit_transform</code><span class="sig-paren">(</span><em>X</em>, <em>y=None</em>, <em>**fit_params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L431"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.base.TransformerMixin.fit_transform" title="Permalink to this definition"></a></dt>
197+
<code class="descname">fit_transform</code><span class="sig-paren">(</span><em>X</em>, <em>y=None</em>, <em>**fit_params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L431"><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"><code class="xref py py-mod docutils literal"><span class="pre">sklearn.calibration</span></code></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><code class="descclassname">sklearn.calibration.</code><code class="descname">CalibratedClassifierCV</code><span class="sig-paren">(</span><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/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><code class="descclassname">sklearn.calibration.</code><code class="descname">CalibratedClassifierCV</code><span class="sig-paren">(</span><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/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="r12" 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">[R12]</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="r13" 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">[R13]</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="r14" 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">[R14]</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="r15" 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">[R15]</a></td><td>Predicting Good Probabilities with Supervised Learning,
265265
A. Niculescu-Mizil &amp; R. Caruana, ICML 2005</td></tr>
266266
</tbody>
267267
</table>
@@ -285,12 +285,12 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
285285
</table>
286286
<dl class="method">
287287
<dt id="sklearn.calibration.CalibratedClassifierCV.__init__">
288-
<code class="descname">__init__</code><span class="sig-paren">(</span><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/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>
288+
<code class="descname">__init__</code><span class="sig-paren">(</span><em>base_estimator=None</em>, <em>method='sigmoid'</em>, <em>cv=3</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/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>
289289
<dd></dd></dl>
290290

291291
<dl class="method">
292292
<dt id="sklearn.calibration.CalibratedClassifierCV.fit">
293-
<code class="descname">fit</code><span class="sig-paren">(</span><em>X</em>, <em>y</em>, <em>sample_weight=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/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>
293+
<code class="descname">fit</code><span class="sig-paren">(</span><em>X</em>, <em>y</em>, <em>sample_weight=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/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>
294294
<dd><p>Fit the calibrated model</p>
295295
<table class="docutils field-list" frame="void" rules="none">
296296
<col class="field-name" />
@@ -322,7 +322,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
322322

323323
<dl class="method">
324324
<dt id="sklearn.calibration.CalibratedClassifierCV.get_params">
325-
<code class="descname">get_params</code><span class="sig-paren">(</span><em>deep=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L199"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.get_params" title="Permalink to this definition"></a></dt>
325+
<code class="descname">get_params</code><span class="sig-paren">(</span><em>deep=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L199"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.get_params" title="Permalink to this definition"></a></dt>
326326
<dd><p>Get parameters for this estimator.</p>
327327
<table class="docutils field-list" frame="void" rules="none">
328328
<col class="field-name" />
@@ -347,7 +347,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
347347

348348
<dl class="method">
349349
<dt id="sklearn.calibration.CalibratedClassifierCV.predict">
350-
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/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>
350+
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/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>
351351
<dd><p>Predict the target of new samples. Can be different from the
352352
prediction of the uncalibrated classifier.</p>
353353
<table class="docutils field-list" frame="void" rules="none">
@@ -372,7 +372,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
372372

373373
<dl class="method">
374374
<dt id="sklearn.calibration.CalibratedClassifierCV.predict_proba">
375-
<code class="descname">predict_proba</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/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>
375+
<code class="descname">predict_proba</code><span class="sig-paren">(</span><em>X</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/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>
376376
<dd><p>Posterior probabilities of classification</p>
377377
<p>This function returns posterior probabilities of classification
378378
according to each class on an array of test vectors X.</p>
@@ -398,7 +398,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
398398

399399
<dl class="method">
400400
<dt id="sklearn.calibration.CalibratedClassifierCV.score">
401-
<code class="descname">score</code><span class="sig-paren">(</span><em>X</em>, <em>y</em>, <em>sample_weight=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L285"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.score" title="Permalink to this definition"></a></dt>
401+
<code class="descname">score</code><span class="sig-paren">(</span><em>X</em>, <em>y</em>, <em>sample_weight=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L285"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.score" title="Permalink to this definition"></a></dt>
402402
<dd><p>Returns the mean accuracy on the given test data and labels.</p>
403403
<p>In multi-label classification, this is the subset accuracy
404404
which is a harsh metric since you require for each sample that
@@ -433,7 +433,7 @@ <h1><a class="reference internal" href="../classes.html#module-sklearn.calibrati
433433

434434
<dl class="method">
435435
<dt id="sklearn.calibration.CalibratedClassifierCV.set_params">
436-
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/base.py#L236"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.set_params" title="Permalink to this definition"></a></dt>
436+
<code class="descname">set_params</code><span class="sig-paren">(</span><em>**params</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/base.py#L236"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.CalibratedClassifierCV.set_params" title="Permalink to this definition"></a></dt>
437437
<dd><p>Set the parameters of this estimator.</p>
438438
<p>The method works on simple estimators as well as on nested objects
439439
(such as pipelines). The former have parameters of the form

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

Lines changed: 1 addition & 1 deletion
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"><code class="xref py py-mod docutils literal"><span class="pre">sklearn.calibration</span></code></a>.calibration_curve<a class="headerlink" href="#sklearn-calibration-calibration-curve" title="Permalink to this headline"></a></h1>
173173
<dl class="function">
174174
<dt id="sklearn.calibration.calibration_curve">
175-
<code class="descclassname">sklearn.calibration.</code><code class="descname">calibration_curve</code><span class="sig-paren">(</span><em>y_true</em>, <em>y_prob</em>, <em>normalize=False</em>, <em>n_bins=5</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/276d928/sklearn/calibration.py#L491"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.calibration_curve" title="Permalink to this definition"></a></dt>
175+
<code class="descclassname">sklearn.calibration.</code><code class="descname">calibration_curve</code><span class="sig-paren">(</span><em>y_true</em>, <em>y_prob</em>, <em>normalize=False</em>, <em>n_bins=5</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/85223b9/sklearn/calibration.py#L491"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#sklearn.calibration.calibration_curve" title="Permalink to this definition"></a></dt>
176176
<dd><p>Compute true and predicted probabilities for a calibration curve.</p>
177177
<p>Read more in the <a class="reference internal" href="../calibration.html#calibration"><span>User Guide</span></a>.</p>
178178
<table class="docutils field-list" frame="void" rules="none">

0 commit comments

Comments
 (0)