Skip to content

Commit

Permalink
Repair docs script for actions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jlgarridol
jlgarridol committed Jun 28, 2024
1 parent 6426f3b commit 19b4bef
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 1,270 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
- run: python -m pip install pdoc
- run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- run: python -m pip install scikit-learn==1.2.2
- run: python -m pip install numpy==1.26.4
# ADJUST THIS: build your documentation into docs/.
# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
- run: python docs/make.py
Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,13 @@ model.score(X_unlabel, true_label)
}
```

Fundings
--------
## Fundings

The research carried out for the development of this software has been partially funded by the Junta de Castilla y León (project BU055P20), by the Ministry of Science and Innovation of Spain (projects PID2020-119894GB-I00 and TED 2021-129485B-C43) and by the project AIM-LAC (EP/S023992 /1). The author has been a beneficiary of the predoctoral scholarship from the Ministry of Education of the Junta de Castilla y León EDU/875/2021.


<!--Add the funding picture-->
![Funding](https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project.svg)
![Funding](https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project_cyl.svg)
<img width="100%" src="https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project.svg" />
<img width="100%" src="https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project_cyl.svg" />


7 changes: 4 additions & 3 deletions docs/make.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
favicon = base64.b64encode(favicon).decode("utf8")
logo = (here / "docs" / "sslearn.webp").read_bytes()
logo = base64.b64encode(logo).decode("utf8")

print("#"*100)
print(here / "src" / "sslearn")
print("#"*100)
# Render main docs
pdoc.render.configure(

Expand All @@ -36,14 +38,13 @@
include_undocumented=False,
docformat="numpy",
)

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


with (here / "sitemap.xml").open("w", newline="\n") as f:
with (here / "docs" / "sitemap.xml").open("w", newline="\n") as f:
f.write(
textwrap.dedent(
"""
Expand Down
2 changes: 1 addition & 1 deletion docs/search.js
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions sitemap.xml → docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
<url><loc>https://pdoc.dev/docs/</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/wrapper.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/utils.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/model_selection.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/subview.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/model_selection.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/base.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/restricted.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/datasets.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/wrapper.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/restricted.html</loc></url>
<url><loc>https://pdoc.dev/docs/sslearn/utils.html</loc></url>
</urlset>
9 changes: 9 additions & 0 deletions docs/sslearn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ <h2>Contents</h2>
<li><a href="#installation">Installation</a></li>
<li><a href="#code-example">Code example</a></li>
<li><a href="#citing">Citing</a></li>
<li><a href="#fundings">Fundings</a></li>
</ul></li>
</ul>

Expand Down Expand Up @@ -144,6 +145,14 @@ <h2 id="citing">Citing</h2>
<span class="p">}</span>
</code></pre>
</div>

<h2 id="fundings">Fundings</h2>

<p>The research carried out for the development of this software has been partially funded by the Junta de Castilla y León (project BU055P20), by the Ministry of Science and Innovation of Spain (projects PID2020-119894GB-I00 and TED 2021-129485B-C43) and by the project AIM-LAC (EP/S023992 /1). The author has been a beneficiary of the predoctoral scholarship from the Ministry of Education of the Junta de Castilla y León EDU/875/2021.</p>

<p><!--Add the funding picture-->
<img width="100%" src="https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project.svg" />
<img width="100%" src="https://raw.githubusercontent.com/admirable-ubu/DN-SSL/main/funding/funding_project_cyl.svg" /></p>
</div>

<input id="mod-sslearn-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
Expand Down
178 changes: 0 additions & 178 deletions docs/sslearn/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,6 @@ <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 @@ -99,12 +96,6 @@ <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 @@ -857,58 +848,6 @@ <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 @@ -921,10 +860,6 @@ <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 @@ -1152,14 +1087,6 @@ <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 @@ -1291,110 +1218,6 @@ <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 @@ -1404,7 +1227,6 @@ <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

0 comments on commit 19b4bef

Please sign in to comment.