Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update directory tree to SOFTX guide #21

Merged
merged 5 commits into from
Jun 21, 2024
Merged

Update directory tree to SOFTX guide #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8e729d1
Update directory tree to SOFTX guide
jlgarridol Jun 21, 2024
30b395b
Update directory tree to SOFTX guide
jlgarridol Jun 21, 2024
938ae5f
Update directory tree to SOFTX guide
jlgarridol Jun 21, 2024
82f1b41
setup.py works propertly
jlgarridol Jun 21, 2024
f71e63c
Documentation script now in the right folder
jlgarridol Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions .readthedocs.yaml
View file
Open in desktop

This file was deleted.

0 LICENSE → License.txt
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/make.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
)

pdoc.pdoc(
here / "sslearn",
here / "src" / "sslearn",
output_directory=here / "docs",
)

Expand Down
2 changes: 1 addition & 1 deletion docs/search.js
View file
Open in desktop

Large diffs are not rendered by default.

178 changes: 178 additions & 0 deletions docs/sslearn/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ <h2>API Documentation</h2>
<li>
<a class="function" href="#FakedProbaClassifier.predict_proba">predict_proba</a>
</li>
<li>
<a class="function" href="#FakedProbaClassifier.set_score_request">set_score_request</a>
</li>
</ul>

</li>
Expand All @@ -96,6 +99,12 @@ <h2>API Documentation</h2>
<li>
<a class="function" href="#OneVsRestSSLClassifier.predict_proba">predict_proba</a>
</li>
<li>
<a class="function" href="#OneVsRestSSLClassifier.set_partial_fit_request">set_partial_fit_request</a>
</li>
<li>
<a class="function" href="#OneVsRestSSLClassifier.set_score_request">set_score_request</a>
</li>
</ul>

</li>
Expand Down Expand Up @@ -848,6 +857,58 @@ <h6 id="returns">Returns</h6>
</div>


</div>
<div id="FakedProbaClassifier.set_score_request" class="classattr">
<div class="attr function">

<span class="def">def</span>
<span class="name">set_score_request</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>


</div>
<a class="headerlink" href="#FakedProbaClassifier.set_score_request"></a>

<div class="docstring"><p>A descriptor for request methods.</p>

<p><em>New in version 1.3.</em></p>

<h6 id="parameters">Parameters</h6>

<ul>
<li><strong>name</strong> (str):
The name of the method for which the request function should be
created, e.g. <code>"fit"</code> would create a <code>set_fit_request</code> function.</li>
<li><strong>keys</strong> (list of str):
A list of strings which are accepted parameters by the created
function, e.g. <code>["sample_weight"]</code> if the corresponding method
accepts it as a metadata.</li>
<li><strong>validate_keys</strong> (bool, default=True):
Whether to check if the requested parameters fit the actual parameters
of the method.</li>
</ul>

<h6 id="notes">Notes</h6>

<p>This class is a descriptor <sup class="footnote-ref" id="fnref-1"><a href="#fn-1">1</a></sup> and uses PEP-362 to set the signature of
the returned function <sup class="footnote-ref" id="fnref-2"><a href="#fn-2">2</a></sup>.</p>

<h6 id="references">References</h6>

<div class="footnotes">
<hr />
<ol>
<li id="fn-1">
<p><a href="https://docs.python.org/3/howto/descriptor.html">https://docs.python.org/3/howto/descriptor.html</a>&#160;<a href="#fnref-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">&#8617;</a></p>
</li>

<li id="fn-2">
<p><a href="https://www.python.org/dev/peps/pep-0362/">https://www.python.org/dev/peps/pep-0362/</a>&#160;<a href="#fnref-2" class="footnoteBackLink" title="Jump back to footnote 2 in the text.">&#8617;</a></p>
</li>
</ol>
</div>
</div>


</div>
<div class="inherited">
<h5>Inherited Members</h5>
Expand All @@ -860,6 +921,10 @@ <h5>Inherited Members</h5>
<dd id="FakedProbaClassifier.get_params" class="function">get_params</dd>
<dd id="FakedProbaClassifier.set_params" class="function">set_params</dd>

</div>
<div><dt>sklearn.utils._metadata_requests._MetadataRequester</dt>
<dd id="FakedProbaClassifier.get_metadata_routing" class="function">get_metadata_routing</dd>

</div>
</dl>
</div>
Expand Down Expand Up @@ -1087,6 +1152,14 @@ <h6 id="parameters">Parameters</h6>
<li><strong>y</strong> ({array-like, sparse matrix} of shape (n_samples,) or (n_samples, n_classes)):
Multi-class targets. An indicator matrix turns on multilabel
classification.</li>
<li><p><strong>**fit_params</strong> (dict):
Parameters passed to the <code>estimator.fit</code> method of each
sub-estimator.</p>

<p><em>New in version 1.4:</em>
Only available if <code>enable_metadata_routing=True</code>. See
:ref:<code>Metadata Routing User Guide &lt;metadata_routing&gt;</code> for more
details.</p></li>
</ul>

<h6 id="returns">Returns</h6>
Expand Down Expand Up @@ -1218,6 +1291,110 @@ <h6 id="returns">Returns</h6>
</div>


</div>
<div id="OneVsRestSSLClassifier.set_partial_fit_request" class="classattr">
<div class="attr function">

<span class="def">def</span>
<span class="name">set_partial_fit_request</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>


</div>
<a class="headerlink" href="#OneVsRestSSLClassifier.set_partial_fit_request"></a>

<div class="docstring"><p>A descriptor for request methods.</p>

<p><em>New in version 1.3.</em></p>

<h6 id="parameters">Parameters</h6>

<ul>
<li><strong>name</strong> (str):
The name of the method for which the request function should be
created, e.g. <code>"fit"</code> would create a <code>set_fit_request</code> function.</li>
<li><strong>keys</strong> (list of str):
A list of strings which are accepted parameters by the created
function, e.g. <code>["sample_weight"]</code> if the corresponding method
accepts it as a metadata.</li>
<li><strong>validate_keys</strong> (bool, default=True):
Whether to check if the requested parameters fit the actual parameters
of the method.</li>
</ul>

<h6 id="notes">Notes</h6>

<p>This class is a descriptor <sup class="footnote-ref" id="fnref-1"><a href="#fn-1">1</a></sup> and uses PEP-362 to set the signature of
the returned function <sup class="footnote-ref" id="fnref-2"><a href="#fn-2">2</a></sup>.</p>

<h6 id="references">References</h6>

<div class="footnotes">
<hr />
<ol>
<li id="fn-1">
<p><a href="https://docs.python.org/3/howto/descriptor.html">https://docs.python.org/3/howto/descriptor.html</a>&#160;<a href="#fnref-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">&#8617;</a></p>
</li>

<li id="fn-2">
<p><a href="https://www.python.org/dev/peps/pep-0362/">https://www.python.org/dev/peps/pep-0362/</a>&#160;<a href="#fnref-2" class="footnoteBackLink" title="Jump back to footnote 2 in the text.">&#8617;</a></p>
</li>
</ol>
</div>
</div>


</div>
<div id="OneVsRestSSLClassifier.set_score_request" class="classattr">
<div class="attr function">

<span class="def">def</span>
<span class="name">set_score_request</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">unknown</span></span><span class="return-annotation">):</span></span>


</div>
<a class="headerlink" href="#OneVsRestSSLClassifier.set_score_request"></a>

<div class="docstring"><p>A descriptor for request methods.</p>

<p><em>New in version 1.3.</em></p>

<h6 id="parameters">Parameters</h6>

<ul>
<li><strong>name</strong> (str):
The name of the method for which the request function should be
created, e.g. <code>"fit"</code> would create a <code>set_fit_request</code> function.</li>
<li><strong>keys</strong> (list of str):
A list of strings which are accepted parameters by the created
function, e.g. <code>["sample_weight"]</code> if the corresponding method
accepts it as a metadata.</li>
<li><strong>validate_keys</strong> (bool, default=True):
Whether to check if the requested parameters fit the actual parameters
of the method.</li>
</ul>

<h6 id="notes">Notes</h6>

<p>This class is a descriptor <sup class="footnote-ref" id="fnref-1"><a href="#fn-1">1</a></sup> and uses PEP-362 to set the signature of
the returned function <sup class="footnote-ref" id="fnref-2"><a href="#fn-2">2</a></sup>.</p>

<h6 id="references">References</h6>

<div class="footnotes">
<hr />
<ol>
<li id="fn-1">
<p><a href="https://docs.python.org/3/howto/descriptor.html">https://docs.python.org/3/howto/descriptor.html</a>&#160;<a href="#fnref-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">&#8617;</a></p>
</li>

<li id="fn-2">
<p><a href="https://www.python.org/dev/peps/pep-0362/">https://www.python.org/dev/peps/pep-0362/</a>&#160;<a href="#fnref-2" class="footnoteBackLink" title="Jump back to footnote 2 in the text.">&#8617;</a></p>
</li>
</ol>
</div>
</div>


</div>
<div class="inherited">
<h5>Inherited Members</h5>
Expand All @@ -1227,6 +1404,7 @@ <h5>Inherited Members</h5>
<dd id="OneVsRestSSLClassifier.decision_function" class="function">decision_function</dd>
<dd id="OneVsRestSSLClassifier.multilabel_" class="variable">multilabel_</dd>
<dd id="OneVsRestSSLClassifier.n_classes_" class="variable">n_classes_</dd>
<dd id="OneVsRestSSLClassifier.get_metadata_routing" class="function">get_metadata_routing</dd>

</div>
<div><dt>sklearn.base.ClassifierMixin</dt>
Expand Down
Loading
Loading