Skip to content

Commit

Permalink
deploy: f1c3962
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Dec 8, 2023
1 parent 94bf93c commit 69dcda8
Show file tree
Hide file tree
Showing 19 changed files with 447 additions and 6 deletions.
3 changes: 2 additions & 1 deletion _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="mltb2/fasttext.html">mltb2.fasttext</a></li>
<ul><li><a href="mltb2/data.html">mltb2.data</a></li>
<li><a href="mltb2/fasttext.html">mltb2.fasttext</a></li>
<li><a href="mltb2/files.html">mltb2.files</a></li>
<li><a href="mltb2/md.html">mltb2.md</a></li>
<li><a href="mltb2/openai.html">mltb2.openai</a></li>
Expand Down
218 changes: 218 additions & 0 deletions _modules/mltb2/data.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions _sources/api-reference/data.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _data_code_doc:

:mod:`~mltb2.data`
==================

.. automodule:: mltb2.data
6 changes: 4 additions & 2 deletions api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="fasttext" href="api-reference/fasttext.html" />
<link rel="next" title="data" href="api-reference/data.html" />
<link rel="prev" title="MLTB2 Documentation" href="index.html" />
</head>

Expand All @@ -50,6 +50,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api-reference/data.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-reference/fasttext.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-reference/files.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api-reference/md.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">md</span></code></a></li>
Expand Down Expand Up @@ -95,6 +96,7 @@
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api-reference/data.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference/fasttext.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference/files.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">files</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="api-reference/md.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">md</span></code></a></li>
Expand All @@ -113,7 +115,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="MLTB2 Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api-reference/fasttext.html" class="btn btn-neutral float-right" title="fasttext" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="api-reference/data.html" class="btn btn-neutral float-right" title="data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
182 changes: 182 additions & 0 deletions api-reference/data.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>data &mdash; MLTB2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=de248184" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="fasttext" href="fasttext.html" />
<link rel="prev" title="API Reference" href="../api-reference.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
MLTB2
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api-reference.html">API Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mltb2.data._load_colon_data"><code class="docutils literal notranslate"><span class="pre">_load_colon_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mltb2.data._load_colon_label"><code class="docutils literal notranslate"><span class="pre">_load_colon_label()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mltb2.data.load_colon"><code class="docutils literal notranslate"><span class="pre">load_colon()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fasttext.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="files.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">files</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="md.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">md</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="openai.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">openai</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="optuna.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">optuna</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="plot.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">plot</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="somajo.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">somajo</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="somajo_transformers.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">somajo_transformers</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="transformers.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">transformers</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/telekom/mltb2">GitHub Repository</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/telekom/mltb2/blob/main/LICENSE">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://www.telekom.com/imprint">Imprint</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">MLTB2</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../api-reference.html">API Reference</a></li>
<li class="breadcrumb-item active"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/telekom/mltb2/blob/main/docs/source/api-reference/data.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="module-mltb2.data">
<span id="data"></span><span id="data-code-doc"></span><h1><a class="reference internal" href="#module-mltb2.data" title="mltb2.data"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a><a class="headerlink" href="#module-mltb2.data" title="Permalink to this heading"></a></h1>
<p>Data loading functionality.</p>
<dl class="py function">
<dt class="sig sig-object py" id="mltb2.data._load_colon_data">
<span class="sig-prename descclassname"><span class="pre">mltb2.data.</span></span><span class="sig-name descname"><span class="pre">_load_colon_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="../_modules/mltb2/data.html#_load_colon_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mltb2.data._load_colon_data" title="Permalink to this definition"></a></dt>
<dd><p>Load colon data (not the labels).</p>
<p>The data is loaded and parsed from the internet.
Also see <a class="reference external" href="http://genomics-pubs.princeton.edu/oncology/affydata/index.html">colon tissues probed by oligonucleotide arrays</a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>data as pandas DataFrame</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><em>DataFrame</em></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mltb2.data._load_colon_label">
<span class="sig-prename descclassname"><span class="pre">mltb2.data.</span></span><span class="sig-name descname"><span class="pre">_load_colon_label</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="reference internal" href="../_modules/mltb2/data.html#_load_colon_label"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mltb2.data._load_colon_label" title="Permalink to this definition"></a></dt>
<dd><p>Load colon label (not the data).</p>
<p>The data is loaded and parsed from the internet.
Also see <a class="reference external" href="http://genomics-pubs.princeton.edu/oncology/affydata/index.html">colon tissues probed by oligonucleotide arrays</a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>labels as pandas Series</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><em>Series</em></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mltb2.data.load_colon">
<span class="sig-prename descclassname"><span class="pre">mltb2.data.</span></span><span class="sig-name descname"><span class="pre">load_colon</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Series</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/mltb2/data.html#load_colon"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mltb2.data.load_colon" title="Permalink to this definition"></a></dt>
<dd><p>Load colon data.</p>
<p>The data is loaded and parsed from the internet.
Also see <a class="reference external" href="http://genomics-pubs.princeton.edu/oncology/affydata/index.html">colon tissues probed by oligonucleotide arrays</a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Tuple containing labels and data.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.12)"><em>Tuple</em></a>[<em>Series</em>, <em>DataFrame</em>]</p>
</dd>
</dl>
</dd></dl>

</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../api-reference.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="fasttext.html" class="btn btn-neutral float-right" title="fasttext" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023, Philip May, Deutsche Telekom AG.</p>
</div>



</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
5 changes: 3 additions & 2 deletions api-reference/fasttext.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="files" href="files.html" />
<link rel="prev" title="API Reference" href="../api-reference.html" />
<link rel="prev" title="data" href="data.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -50,6 +50,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api-reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="data.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mltb2.fasttext.FastTextLanguageIdentification"><code class="docutils literal notranslate"><span class="pre">FastTextLanguageIdentification</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mltb2.fasttext.FastTextLanguageIdentification.__call__"><code class="docutils literal notranslate"><span class="pre">FastTextLanguageIdentification.__call__()</span></code></a></li>
Expand Down Expand Up @@ -160,7 +161,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../api-reference.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="data.html" class="btn btn-neutral float-left" title="data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="files.html" class="btn btn-neutral float-right" title="files" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions api-reference/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api-reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="data.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="fasttext.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">files</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#mltb2.files.fetch_remote_file"><code class="docutils literal notranslate"><span class="pre">fetch_remote_file()</span></code></a></li>
Expand Down
1 change: 1 addition & 0 deletions api-reference/md.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api-reference.html">API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="data.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">data</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="fasttext.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">fasttext</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="files.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">files</span></code></a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">md</span></code></a><ul>
Expand Down
Loading

0 comments on commit 69dcda8

Please sign in to comment.