Skip to content

Commit

Permalink
deploy: b84a4ee
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeipollack
jeipollack committed Nov 8, 2023
1 parent 1225e79 commit de48ccf
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 34 deletions.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/wf_psf.utils.configs_handler.doctree
View file
Binary file not shown.
Binary file modified .doctrees/wf_psf.utils.io.doctree
View file
Binary file not shown.
60 changes: 35 additions & 25 deletions _modules/wf_psf/utils/configs_handler.html
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions _modules/wf_psf/utils/io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ <h1>Source code for wf_psf.utils.io</h1><div class="highlight"><pre>

<div class="viewcode-block" id="FileIOHandler.get_config_dir">
<a class="viewcode-back" href="../../../wf_psf.utils.io.html#wf_psf.utils.io.FileIOHandler.get_config_dir">[docs]</a>
<span class="k">def</span> <span class="nf">get_config_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_config_dir</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">run_output_dir</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get Config Directory.</span>

<span class="sd"> A function that returns path</span>
Expand All @@ -274,11 +274,11 @@ <h1>Source code for wf_psf.utils.io</h1><div class="highlight"><pre>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> str</span>
<span class="sd"> Absolute path to checkpoint directory</span>
<span class="sd"> Absolute path to config directory</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_run_output_dir</span><span class="p">,</span>
<span class="n">run_output_dir</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_config</span><span class="p">,</span>
<span class="p">)</span></div>

Expand All @@ -300,7 +300,7 @@ <h1>Source code for wf_psf.utils.io</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">source</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config_path</span><span class="p">,</span> <span class="n">source_file</span><span class="p">)</span>
<span class="n">destination</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_config_dir</span><span class="p">(),</span> <span class="n">source_file</span><span class="p">)</span>
<span class="n">destination</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_config_dir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_run_output_dir</span><span class="p">),</span> <span class="n">source_file</span><span class="p">)</span>

<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">destination</span><span class="p">)</span></div>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion wf_psf.utils.configs_handler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@

<dl class="py class">
<dt class="sig sig-object py" id="wf_psf.utils.configs_handler.PlottingConfigHandler">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wf_psf.utils.configs_handler.</span></span><span class="sig-name descname"><span class="pre">PlottingConfigHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plotting_conf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_handler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metrics_conf</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/wf_psf/utils/configs_handler.html#PlottingConfigHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wf_psf.utils.configs_handler.PlottingConfigHandler" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wf_psf.utils.configs_handler.</span></span><span class="sig-name descname"><span class="pre">PlottingConfigHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">plotting_conf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_handler</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/wf_psf/utils/configs_handler.html#PlottingConfigHandler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wf_psf.utils.configs_handler.PlottingConfigHandler" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>PlottingConfigHandler.</p>
<p>A class to handle plotting config
Expand Down
6 changes: 3 additions & 3 deletions wf_psf.utils.io.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
<tr class="row-even"><td><p><a class="reference internal" href="#wf_psf.utils.io.FileIOHandler.get_checkpoint_dir" title="wf_psf.utils.io.FileIOHandler.get_checkpoint_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_checkpoint_dir</span></code></a>(checkpoint_dir)</p></td>
<td><p>Get Checkpoint Directory.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#wf_psf.utils.io.FileIOHandler.get_config_dir" title="wf_psf.utils.io.FileIOHandler.get_config_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config_dir</span></code></a>()</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#wf_psf.utils.io.FileIOHandler.get_config_dir" title="wf_psf.utils.io.FileIOHandler.get_config_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config_dir</span></code></a>(run_output_dir)</p></td>
<td><p>Get Config Directory.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#wf_psf.utils.io.FileIOHandler.get_metrics_dir" title="wf_psf.utils.io.FileIOHandler.get_metrics_dir"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_metrics_dir</span></code></a>(metrics_dir)</p></td>
Expand Down Expand Up @@ -207,13 +207,13 @@

<dl class="py method">
<dt class="sig sig-object py" id="wf_psf.utils.io.FileIOHandler.get_config_dir">
<span class="sig-name descname"><span class="pre">get_config_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/wf_psf/utils/io.html#FileIOHandler.get_config_dir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wf_psf.utils.io.FileIOHandler.get_config_dir" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">get_config_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run_output_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/wf_psf/utils/io.html#FileIOHandler.get_config_dir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#wf_psf.utils.io.FileIOHandler.get_config_dir" title="Link to this definition"></a></dt>
<dd><p>Get Config Directory.</p>
<p>A function that returns path
of config directory.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Absolute path to checkpoint directory</p>
<dd class="field-odd"><p>Absolute path to config directory</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/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
Expand Down

0 comments on commit de48ccf

Please sign in to comment.