add documentation for helper module;

GU-DataLab · Apr 22, 2022 · 91ac479 · 91ac479
1 parent b69991a
commit 91ac479
Show file tree

Hide file tree

Showing 15 changed files with 708 additions and 51 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/gdtm/helpers/common.doctree b/docs/build/doctrees/gdtm/helpers/common.doctree
diff --git a/docs/build/doctrees/gdtm/helpers/exceptions.doctree b/docs/build/doctrees/gdtm/helpers/exceptions.doctree
diff --git a/docs/build/doctrees/gdtm/helpers/weighting.doctree b/docs/build/doctrees/gdtm/helpers/weighting.doctree
diff --git a/docs/build/html/gdtm/helpers/common.html b/docs/build/html/gdtm/helpers/common.html
diff --git a/docs/build/html/gdtm/helpers/exceptions.html b/docs/build/html/gdtm/helpers/exceptions.html
@@ -81,36 +81,42 @@
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.MissingDataSetError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">MissingDataSetError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.MissingDataSetError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for model classes that are initialized without a data set or a pretrained model.</p>
 </dd></dl>
 
 <dl class="py exception">
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.MissingEmbeddingPathError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">MissingEmbeddingPathError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.MissingEmbeddingPathError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for embedded model classes that are initialized without a path to embedding vectors.</p>
 </dd></dl>
 
 <dl class="py exception">
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.MissingModelError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">MissingModelError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.MissingModelError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for model classes that are initialized without the underlying Java model or a pretrained model.</p>
 </dd></dl>
 
 <dl class="py exception">
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.MissingSeedWeightsError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">MissingSeedWeightsError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.MissingSeedWeightsError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for GTM wrapper class that is initialized without seed weights.</p>
 </dd></dl>
 
 <dl class="py exception">
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.MissingSeedsError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">MissingSeedsError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.MissingSeedsError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for Guided Topic-Noise model class that is initialized without seed topics.</p>
 </dd></dl>
 
 <dl class="py exception">
 <dt class="sig sig-object py" id="gdtm.helpers.exceptions.NotEnoughTopicSetsError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gdtm.helpers.exceptions.</span></span><span class="sig-name descname"><span class="pre">NotEnoughTopicSetsError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.exceptions.NotEnoughTopicSetsError" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
+<p>Error for CSTB functions that are not provided at least two topic sets for blending.</p>
 </dd></dl>
 
 </section>

diff --git a/docs/build/html/gdtm/helpers/weighting.html b/docs/build/html/gdtm/helpers/weighting.html
@@ -78,7 +78,19 @@
 <dl class="py function">
 <dt class="sig sig-object py" id="gdtm.helpers.weighting.compute_idf_weights">
 <span class="sig-prename descclassname"><span class="pre">gdtm.helpers.weighting.</span></span><span class="sig-name descname"><span class="pre">compute_idf_weights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">topics</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gdtm.helpers.weighting.compute_idf_weights" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
+<dd><p>For each topic word, computes the inverse document frequency (IDF) of the words for seed topic weighting.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>dataset</strong> – list of lists</p></li>
+<li><p><strong>topics</strong> – list of lists (topic words)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>list of lists (weights of topic words)</p>
+</dd>
+</dl>
+</dd></dl>
 
 </section>