Skip to content

Commit

Permalink
2. documentation and readmefile
Browse files Browse the repository at this point in the history
  • Loading branch information
@qnater
qnater committed Oct 17, 2024
1 parent e36f7a1 commit 905bee7
Show file tree
Hide file tree
Showing 75 changed files with 528 additions and 365 deletions.
354 changes: 198 additions & 156 deletions .idea/workspace.xml
View file

Large diffs are not rendered by default.

Binary file added docs/build/doctrees/_autosummary/imputegap.recovery.evaluation.doctree
View file
Binary file not shown.
Binary file removed docs/build/doctrees/_autosummary/imputegap.tools.evaluation.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/imputegap.evaluation.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/build/html/_autosummary/imputegap.algorithms.cdrec.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="imputegap.algorithms.stmvl" href="imputegap.algorithms.stmvl.html" />
<link rel="prev" title="imputegap.recovery.explainer" href="imputegap.recovery.explainer.html" />
<link rel="prev" title="imputegap.recovery.evaluation" href="imputegap.recovery.evaluation.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down Expand Up @@ -105,7 +105,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="imputegap.recovery.explainer.html" class="btn btn-neutral float-left" title="imputegap.recovery.explainer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="imputegap.recovery.evaluation.html" class="btn btn-neutral float-left" title="imputegap.recovery.evaluation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="imputegap.algorithms.stmvl.html" class="btn btn-neutral float-right" title="imputegap.algorithms.stmvl" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.iim.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.min_impute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.mrnn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.stmvl.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_autosummary/imputegap.algorithms.zero_impute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.evaluation.html">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.evaluation.html">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand Down
22 changes: 11 additions & 11 deletions ...tosummary/imputegap.tools.evaluation.html → ...ummary/imputegap.recovery.evaluation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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>imputegap.tools.evaluation &mdash; imputegap 0.1.4 documentation</title>
<title>imputegap.recovery.evaluation &mdash; imputegap 0.1.4 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=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css" />
Expand All @@ -20,8 +20,8 @@
<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="imputegap package" href="../imputegap.html" />
<link rel="prev" title="imputegap.tools.utils" href="imputegap.tools.utils.html" />
<link rel="next" title="imputegap.algorithms.cdrec" href="imputegap.algorithms.cdrec.html" />
<link rel="prev" title="imputegap.recovery.explainer" href="imputegap.recovery.explainer.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -49,14 +49,14 @@
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.imputation.html">imputegap.recovery.imputation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.optimization.html">imputegap.recovery.optimization</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.recovery.explainer.html">imputegap.recovery.explainer</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.recovery.evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.cdrec.html">imputegap.algorithms.cdrec</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.stmvl.html">imputegap.algorithms.stmvl</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.iim.html">imputegap.algorithms.iim</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.mrnn.html">imputegap.algorithms.mrnn</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.min_impute.html">imputegap.algorithms.min_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.algorithms.zero_impute.html">imputegap.algorithms.zero_impute</a></li>
<li class="toctree-l1"><a class="reference internal" href="imputegap.tools.utils.html">imputegap.tools.utils</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">imputegap.tools.evaluation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../imputegap.html">imputegap package</a></li>
Expand All @@ -76,22 +76,22 @@
<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 active">imputegap.tools.evaluation</li>
<li class="breadcrumb-item active">imputegap.recovery.evaluation</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/qnater/https://github.com/eXascaleInfolab/ImputeGAP/blob/https://github.com/eXascaleInfolab/ImputeGAP_autosummary/imputegap.tools.evaluation.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/qnater/https://github.com/eXascaleInfolab/ImputeGAP/blob/https://github.com/eXascaleInfolab/ImputeGAP_autosummary/imputegap.recovery.evaluation.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-imputegap.tools.evaluation">
<span id="imputegap-tools-evaluation"></span><h1>imputegap.tools.evaluation<a class="headerlink" href="#module-imputegap.tools.evaluation" title="Link to this heading"></a></h1>
<section id="module-imputegap.recovery.evaluation">
<span id="imputegap-recovery-evaluation"></span><h1>imputegap.recovery.evaluation<a class="headerlink" href="#module-imputegap.recovery.evaluation" title="Link to this heading"></a></h1>
<p class="rubric">Classes</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../imputegap.evaluation.html#id0" title="imputegap.tools.evaluation.Evaluation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Evaluation</span></code></a>(ground_truth, imputation, ...)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../imputegap.evaluation.html#id0" title="imputegap.recovery.evaluation.Evaluation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Evaluation</span></code></a>(ground_truth, imputation, ...)</p></td>
<td><p>A class to evaluate the performance of imputation algorithms by comparing imputed time series with the ground truth.</p></td>
</tr>
</tbody>
Expand All @@ -102,8 +102,8 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="imputegap.tools.utils.html" class="btn btn-neutral float-left" title="imputegap.tools.utils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../imputegap.html" class="btn btn-neutral float-right" title="imputegap package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="imputegap.recovery.explainer.html" class="btn btn-neutral float-left" title="imputegap.recovery.explainer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="imputegap.algorithms.cdrec.html" class="btn btn-neutral float-right" title="imputegap.algorithms.cdrec" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit 905bee7

Please sign in to comment.