Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
postpop committed Feb 3, 2024
1 parent 9e982f6 commit b47b3db
Show file tree
Hide file tree
Showing 109 changed files with 3,826 additions and 5,643 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
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: f2b6eff1bd81e97cf224aeba3a01bf82
config: 0d0cb37fa096d078f78dc57c0de1cd95
tags: 645f666f9bcd5a90fca523b33c5a78b7
31 changes: 18 additions & 13 deletions _modules/das/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />

<!-- Generated with Sphinx 4.5.0 and Furo 2023.03.27 -->
<meta name="generator" content="sphinx-4.5.0, furo 2022.06.21"/>
<title>das.cli - DAS documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
<link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
<link rel="stylesheet" type="text/css" href="../../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/tabs.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/css/lightbox.css" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/css/lightbox.css" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />


Expand Down Expand Up @@ -157,7 +157,7 @@


</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
Expand Down Expand Up @@ -317,11 +317,11 @@ <h1>Source code for das.cli</h1><div class="highlight"><pre>

<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; </span><span class="si">{</span><span class="n">platform</span><span class="o">.</span><span class="n">platform</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; DAS v</span><span class="si">{</span><span class="n">das</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; GUI is </span><span class="si">{</span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">has_gui</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s1">&#39;not&#39;</span><span class="si">}</span><span class="s2">available.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; GUI is </span><span class="si">{</span><span class="s1">&#39;&#39;</span> <span class="k">if</span> <span class="n">has_gui</span> <span class="k">else</span> <span class="s1">&#39;not&#39;</span><span class="si">}</span><span class="s2">available.&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">has_gui</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; xarray-behave v</span><span class="si">{</span><span class="n">xb</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; pyqtgraph v</span><span class="si">{</span><span class="n">pyqtgraph</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; </span><span class="si">{</span><span class="n">qtpy</span><span class="o">.</span><span class="n">API_NAME</span><span class="si">}</span><span class="s2"> v</span><span class="si">{</span><span class="n">qtpy</span><span class="o">.</span><span class="n">PYQT_VERSION</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">qtpy</span><span class="o">.</span><span class="n">PYSIDE_VERSION</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; </span><span class="si">{</span><span class="n">qtpy</span><span class="o">.</span><span class="n">API_NAME</span><span class="si">}</span><span class="s2"> v</span><span class="si">{</span><span class="n">qtpy</span><span class="o">.</span><span class="n">PYQT_VERSION</span> <span class="ow">or</span> <span class="n">qtpy</span><span class="o">.</span><span class="n">PYSIDE_VERSION</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; Qt v</span><span class="si">{</span><span class="n">qtpy</span><span class="o">.</span><span class="n">QT_VERSION</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>

<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
Expand All @@ -330,7 +330,7 @@ <h1>Source code for das.cli</h1><div class="highlight"><pre>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; keras v</span><span class="si">{</span><span class="n">keras</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; keras v</span><span class="si">{</span><span class="n">tensorflow</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; GPU is </span><span class="si">{</span><span class="s1">&#39;&#39;</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">gpu</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s1">&#39;not&#39;</span><span class="si">}</span><span class="s2"> available.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; GPU is </span><span class="si">{</span><span class="s1">&#39;&#39;</span> <span class="k">if</span> <span class="n">gpu</span> <span class="k">else</span> <span class="s1">&#39;not&#39;</span><span class="si">}</span><span class="s2"> available.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; python v</span><span class="si">{</span><span class="n">sys</span><span class="o">.</span><span class="n">version</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; pandas v</span><span class="si">{</span><span class="n">pd</span><span class="o">.</span><span class="n">__version__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
Expand All @@ -342,14 +342,14 @@ <h1>Source code for das.cli</h1><div class="highlight"><pre>


<div class="viewcode-block" id="no_xb_gui"><a class="viewcode-back" href="../../api/das.cli.html#das.cli.no_xb_gui">[docs]</a><span class="k">def</span> <span class="nf">no_xb_gui</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Could not import the GUI. For instructions on how to install the GUI, check the docs janclemenslab.org/das/install.html.&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;Could not import the GUI. For instructions on how to install the GUI, check the docs janclemenslab.org/das/install.html.&quot;&quot;&quot;</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;Could not import the GUI.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;For instructions on how to install the GUI,&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s2">&quot;check the docs janclemenslab.org/das/install.html.&quot;</span><span class="p">)</span></div>


<div class="viewcode-block" id="main"><a class="viewcode-back" href="../../api/das.cli.html#das.cli.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Command line interface for DAS.&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;Command line interface for DAS.&quot;&quot;&quot;</span>
<span class="n">subcommands</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;train&quot;</span><span class="p">:</span> <span class="n">train</span><span class="o">.</span><span class="n">train</span><span class="p">,</span>
<span class="c1"># &quot;tune&quot;: train_tune.train,</span>
Expand Down Expand Up @@ -393,7 +393,9 @@ <h1>Source code for das.cli</h1><div class="highlight"><pre>

</div>
<div class="right-details">

<div class="icons">

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

Expand All @@ -411,8 +413,11 @@ <h1>Source code for das.cli</h1><div class="highlight"><pre>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/scripts/furo.js"></script>
<script src="../../_static/tabs.js"></script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="../../_static/togglebutton.js"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2/dist/js/lightbox-plus-jquery.min.js"></script>
<script src="../../_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
</body>
Expand Down
Loading

0 comments on commit b47b3db

Please sign in to comment.