Skip to content

Commit

Permalink
updated requirements for rtd
Browse files Browse the repository at this point in the history
  • Loading branch information
@lyna1404
lyna1404 committed Sep 10, 2024
1 parent 4722e34 commit 5c9b441
Show file tree
Hide file tree
Showing 76 changed files with 3,526 additions and 14,306 deletions.
Binary file removed docs/_build/doctrees/MED3pa.datasets.doctree
View file
Binary file not shown.
Binary file removed docs/_build/doctrees/MED3pa.detectron.doctree
View file
Binary file not shown.
Binary file removed docs/_build/doctrees/MED3pa.med3pa.doctree
View file
Binary file not shown.
Binary file removed docs/_build/doctrees/MED3pa.models.doctree
View file
Binary file not shown.
Binary file removed docs/_build/doctrees/index.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0bb0c288d4fb27fed16b7fb6db0ad63b
config: 16d1d77b3d6ca16a98d36bfb275c3dd6
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/_build/html/.doctrees/MED3pa.datasets.doctree
View file
Binary file not shown.
Binary file added docs/_build/html/.doctrees/MED3pa.detectron.doctree
View file
Binary file not shown.
Binary file renamed docs/_build/doctrees/MED3pa.doctree → docs/_build/html/.doctrees/MED3pa.doctree
View file
Binary file not shown.
Binary file added docs/_build/html/.doctrees/MED3pa.med3pa.doctree
View file
Binary file not shown.
Binary file added docs/_build/html/.doctrees/MED3pa.models.doctree
View file
Binary file not shown.
Binary file renamed ...build/doctrees/datasets_tutorials.doctree → ...html/.doctrees/datasets_tutorials.doctree
View file
Binary file not shown.
Binary file renamed ...uild/doctrees/detectron_tutorials.doctree → ...tml/.doctrees/detectron_tutorials.doctree
View file
Binary file not shown.
Binary file renamed docs/_build/doctrees/environment.pickle → .../_build/html/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file added docs/_build/html/.doctrees/index.doctree
View file
Binary file not shown.
Binary file renamed docs/_build/doctrees/installation.doctree → ...build/html/.doctrees/installation.doctree
View file
Binary file not shown.
Binary file renamed .../_build/doctrees/med3pa_tutorials.doctree → ...d/html/.doctrees/med3pa_tutorials.doctree
View file
Binary file not shown.
Binary file renamed .../_build/doctrees/models_tutorials.doctree → ...d/html/.doctrees/models_tutorials.doctree
View file
Binary file not shown.
Binary file renamed docs/_build/doctrees/tutorials.doctree → docs/_build/html/.doctrees/tutorials.doctree
View file
Binary file not shown.
195 changes: 130 additions & 65 deletions docs/_build/html/MED3pa.datasets.html
View file

Large diffs are not rendered by default.

129 changes: 84 additions & 45 deletions docs/_build/html/MED3pa.detectron.html
View file

Large diffs are not rendered by default.

448 changes: 415 additions & 33 deletions docs/_build/html/MED3pa.html
View file

Large diffs are not rendered by default.

397 changes: 269 additions & 128 deletions docs/_build/html/MED3pa.med3pa.html
View file

Large diffs are not rendered by default.

397 changes: 272 additions & 125 deletions docs/_build/html/MED3pa.models.html
View file

Large diffs are not rendered by default.

47 changes: 32 additions & 15 deletions docs/_build/html/_modules/MED3pa/datasets/loading_context.html
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>MED3pa.datasets.loading_context &mdash; Med3pa documentation 0.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<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/custom.css?v=91a569d5" />


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

<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=01f34227"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
Expand Down Expand Up @@ -95,7 +97,9 @@ <h1>Source code for MED3pa.datasets.loading_context</h1><div class="highlight"><
<span class="kn">from</span> <span class="nn">.loading_strategies</span> <span class="kn">import</span> <span class="n">DataLoadingStrategy</span><span class="p">,</span> <span class="n">CSVDataLoadingStrategy</span>


<div class="viewcode-block" id="DataLoadingContext"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext">[docs]</a><span class="k">class</span> <span class="nc">DataLoadingContext</span><span class="p">:</span>
<div class="viewcode-block" id="DataLoadingContext">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext">[docs]</a>
<span class="k">class</span> <span class="nc">DataLoadingContext</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A context class for managing data loading strategies. It supports setting and getting the current</span>
<span class="sd"> data loading strategy, as well as loading data as a NumPy array from a specified file.</span>
Expand All @@ -121,7 +125,9 @@ <h1>Source code for MED3pa.datasets.loading_context</h1><div class="highlight"><
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;This file extension is not supported yet: &#39;</span><span class="si">{</span><span class="n">file_extension</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">selected_strategy</span> <span class="o">=</span> <span class="n">strategy_class</span><span class="p">()</span>

<div class="viewcode-block" id="DataLoadingContext.set_strategy"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.set_strategy">[docs]</a> <span class="k">def</span> <span class="nf">set_strategy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strategy</span><span class="p">:</span> <span class="n">DataLoadingStrategy</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<div class="viewcode-block" id="DataLoadingContext.set_strategy">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.set_strategy">[docs]</a>
<span class="k">def</span> <span class="nf">set_strategy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strategy</span><span class="p">:</span> <span class="n">DataLoadingStrategy</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sets a new data loading strategy.</span>

Expand All @@ -130,7 +136,10 @@ <h1>Source code for MED3pa.datasets.loading_context</h1><div class="highlight"><
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">selected_strategy</span> <span class="o">=</span> <span class="n">strategy</span></div>

<div class="viewcode-block" id="DataLoadingContext.get_strategy"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.get_strategy">[docs]</a> <span class="k">def</span> <span class="nf">get_strategy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataLoadingStrategy</span><span class="p">:</span>

<div class="viewcode-block" id="DataLoadingContext.get_strategy">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.get_strategy">[docs]</a>
<span class="k">def</span> <span class="nf">get_strategy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">DataLoadingStrategy</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the currently selected data loading strategy.</span>

Expand All @@ -139,7 +148,10 @@ <h1>Source code for MED3pa.datasets.loading_context</h1><div class="highlight"><
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">selected_strategy</span></div>

<div class="viewcode-block" id="DataLoadingContext.load_as_np"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.load_as_np">[docs]</a> <span class="k">def</span> <span class="nf">load_as_np</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>

<div class="viewcode-block" id="DataLoadingContext.load_as_np">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.DataLoadingContext.load_as_np">[docs]</a>
<span class="k">def</span> <span class="nf">load_as_np</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Loads data from the given file path and returns it as a NumPy array, along with column labels and the target data.</span>

Expand All @@ -151,17 +163,22 @@ <h1>Source code for MED3pa.datasets.loading_context</h1><div class="highlight"><
<span class="sd"> Tuple[List[str], np.ndarray, np.ndarray]: A tuple containing the column labels, observations as a NumPy array, </span>
<span class="sd"> and the target as a NumPy array.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">selected_strategy</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">)</span></div></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">selected_strategy</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">)</span></div>
</div>



<div class="viewcode-block" id="supported_file_formats"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.supported_file_formats">[docs]</a><span class="k">def</span> <span class="nf">supported_file_formats</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<div class="viewcode-block" id="supported_file_formats">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_context.supported_file_formats">[docs]</a>
<span class="k">def</span> <span class="nf">supported_file_formats</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns a list of supported file formats.</span>

<span class="sd"> Returns:</span>
<span class="sd"> List[str]: A list of supported file formats.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">DataLoadingContext</span><span class="o">.</span><span class="n">strategies</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>

</pre></div>

</div>
Expand Down
44 changes: 29 additions & 15 deletions docs/_build/html/_modules/MED3pa/datasets/loading_strategies.html
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>MED3pa.datasets.loading_strategies &mdash; Med3pa documentation 0.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<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/custom.css?v=91a569d5" />


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

<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=01f34227"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
Expand Down Expand Up @@ -96,11 +98,15 @@ <h1>Source code for MED3pa.datasets.loading_strategies</h1><div class="highlight
<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span>


<div class="viewcode-block" id="DataLoadingStrategy"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.DataLoadingStrategy">[docs]</a><span class="k">class</span> <span class="nc">DataLoadingStrategy</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
<div class="viewcode-block" id="DataLoadingStrategy">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.DataLoadingStrategy">[docs]</a>
<span class="k">class</span> <span class="nc">DataLoadingStrategy</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Abstract base class for data loading strategies. Defines a common interface for all data loading strategies.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="DataLoadingStrategy.execute"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.DataLoadingStrategy.execute">[docs]</a> <span class="nd">@abstractmethod</span>
<div class="viewcode-block" id="DataLoadingStrategy.execute">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.DataLoadingStrategy.execute">[docs]</a>
<span class="nd">@abstractmethod</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">path_to_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Abstract method to execute the data loading strategy.</span>
Expand All @@ -114,10 +120,14 @@ <h1>Source code for MED3pa.datasets.loading_strategies</h1><div class="highlight
<span class="sd"> and the target as a NumPy array.</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div></div>
<span class="k">pass</span></div>
</div>


<div class="viewcode-block" id="CSVDataLoadingStrategy"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.CSVDataLoadingStrategy">[docs]</a><span class="k">class</span> <span class="nc">CSVDataLoadingStrategy</span><span class="p">(</span><span class="n">DataLoadingStrategy</span><span class="p">):</span>

<div class="viewcode-block" id="CSVDataLoadingStrategy">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.CSVDataLoadingStrategy">[docs]</a>
<span class="k">class</span> <span class="nc">CSVDataLoadingStrategy</span><span class="p">(</span><span class="n">DataLoadingStrategy</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Strategy class for loading CSV data. Implements the abstract execute method to handle CSV files.</span>

Expand All @@ -126,7 +136,9 @@ <h1>Source code for MED3pa.datasets.loading_strategies</h1><div class="highlight
<span class="sd"> Loads CSV data from the given path, separates observations and target, and converts them to NumPy arrays.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<div class="viewcode-block" id="CSVDataLoadingStrategy.execute"><a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.CSVDataLoadingStrategy.execute">[docs]</a> <span class="nd">@staticmethod</span>
<div class="viewcode-block" id="CSVDataLoadingStrategy.execute">
<a class="viewcode-back" href="../../../MED3pa.datasets.html#MED3pa.datasets.loading_strategies.CSVDataLoadingStrategy.execute">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">path_to_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">target_column_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Loads CSV data from the given path, separates observations and target, and converts them to NumPy arrays.</span>
Expand All @@ -150,7 +162,9 @@ <h1>Source code for MED3pa.datasets.loading_strategies</h1><div class="highlight
<span class="n">obs_np</span> <span class="o">=</span> <span class="n">observations</span><span class="o">.</span><span class="n">to_numpy</span><span class="p">()</span>
<span class="n">target_np</span> <span class="o">=</span> <span class="n">target</span><span class="o">.</span><span class="n">to_numpy</span><span class="p">()</span>

<span class="k">return</span> <span class="n">column_labels</span><span class="p">,</span> <span class="n">obs_np</span><span class="p">,</span> <span class="n">target_np</span></div></div>
<span class="k">return</span> <span class="n">column_labels</span><span class="p">,</span> <span class="n">obs_np</span><span class="p">,</span> <span class="n">target_np</span></div>
</div>



</pre></div>
Expand Down
Loading

0 comments on commit 5c9b441

Please sign in to comment.