Skip to content

Commit ad2d272

Browse files
committed
Rebuild dev docs at master=c60f72b
1 parent 8c20024 commit ad2d272

File tree

228 files changed

+1319
-1319
lines changed

Some content is hidden

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

228 files changed

+1319
-1319
lines changed

dev/_sources/developers/contributing.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Easy Issues
214214

215215
A great way to start contributing to scikit-learn is to pick an item from the
216216
list of `Easy issues
217-
<https://github.com/scikit-learn/scikit-learn/labels/Easy>`_
217+
<https://github.com/scikit-learn/scikit-learn/issues?q=is%3Aopen+label%3AEasy+is%3Aissue>`_
218218
in the issue tracker. Resolving these issues allow you to start contributing
219219
to the project without much prior knowledge. Your assistance in this area will
220220
be greatly appreciated by the more experienced developers as it helps free up

dev/developers/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ <h3>How to contribute<a class="headerlink" href="#how-to-contribute" title="Perm
411411
<div class="section" id="easy-issues">
412412
<span id="id2"></span><h3>Easy Issues<a class="headerlink" href="#easy-issues" title="Permalink to this headline"></a></h3>
413413
<p>A great way to start contributing to scikit-learn is to pick an item from the
414-
list of <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/labels/Easy">Easy issues</a>
414+
list of <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/issues?q=is%3Aopen+label%3AEasy+is%3Aissue">Easy issues</a>
415415
in the issue tracker. Resolving these issues allow you to start contributing
416416
to the project without much prior knowledge. Your assistance in this area will
417417
be greatly appreciated by the more experienced developers as it helps free up

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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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: 8 additions & 8 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/23f2891/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/c60f72b/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.
@@ -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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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/23f2891/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/c60f72b/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

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"><tt class="xref py py-mod docutils literal"><span class="pre">sklearn.calibration</span></tt></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-
<tt class="descclassname">sklearn.calibration.</tt><tt class="descname">calibration_curve</tt><big>(</big><em>y_true</em>, <em>y_prob</em>, <em>normalize=False</em>, <em>n_bins=5</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/23f2891/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+
<tt class="descclassname">sklearn.calibration.</tt><tt class="descname">calibration_curve</tt><big>(</big><em>y_true</em>, <em>y_prob</em>, <em>normalize=False</em>, <em>n_bins=5</em><big>)</big><a class="reference external" href="https://github.com/scikit-learn/scikit-learn/blob/c60f72b/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"><em>User Guide</em></a>.</p>
178178
<table class="docutils field-list" frame="void" rules="none">

0 commit comments

Comments
 (0)