Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Apr 8, 2024
1 parent b6eddcf commit 9c23fab
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions develop/_modules/otx/core/config/data.html
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ <h1>Source code for otx.core.config.data</h1><div class="highlight"><pre>
<span class="n">stack_images</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span>

<span class="n">include_polygons</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">ignore_index</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">255</span>
<span class="n">unannotated_items_ratio</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span>

<span class="n">auto_num_workers</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
Expand Down
2 changes: 1 addition & 1 deletion develop/_modules/otx/core/data/factory.html
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ <h1>Source code for otx.core.data.factory</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="n">task</span> <span class="o">==</span> <span class="n">OTXTaskType</span><span class="o">.</span><span class="n">SEMANTIC_SEGMENTATION</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">.dataset.segmentation</span> <span class="kn">import</span> <span class="n">OTXSegmentationDataset</span>

<span class="k">return</span> <span class="n">OTXSegmentationDataset</span><span class="p">(</span><span class="o">**</span><span class="n">common_kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">OTXSegmentationDataset</span><span class="p">(</span><span class="o">**</span><span class="n">common_kwargs</span><span class="p">,</span> <span class="n">ignore_index</span><span class="o">=</span><span class="n">cfg_data_module</span><span class="o">.</span><span class="n">ignore_index</span><span class="p">)</span>

<span class="k">if</span> <span class="n">task</span> <span class="o">==</span> <span class="n">OTXTaskType</span><span class="o">.</span><span class="n">ACTION_CLASSIFICATION</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">.dataset.action_classification</span> <span class="kn">import</span> <span class="n">OTXActionClsDataset</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@
</table>
<dl class="py class">
<dt class="sig sig-object py" id="otx.core.config.data.DataModuleConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">otx.core.config.data.</span></span><span class="sig-name descname"><span class="pre">DataModuleConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_format:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_root:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tile_config:</span> <span class="pre">~otx.core.config.data.TileConfig</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vpm_config:</span> <span class="pre">~otx.core.config.data.VisualPromptingConfig</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mem_cache_size:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'1GB'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mem_cache_img_max_size:</span> <span class="pre">tuple[int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int]</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_color_channel:</span> <span class="pre">~otx.core.types.image.ImageColorChannel</span> <span class="pre">=</span> <span class="pre">ImageColorChannel.RGB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stack_images:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_polygons:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unannotated_items_ratio:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_num_workers:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device:</span> <span class="pre">~otx.core.types.device.DeviceType</span> <span class="pre">=</span> <span class="pre">DeviceType.auto</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/otx/core/config/data.html#DataModuleConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#otx.core.config.data.DataModuleConfig" 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">otx.core.config.data.</span></span><span class="sig-name descname"><span class="pre">DataModuleConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_format:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_root:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_subset:</span> <span class="pre">~otx.core.config.data.SubsetConfig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tile_config:</span> <span class="pre">~otx.core.config.data.TileConfig</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vpm_config:</span> <span class="pre">~otx.core.config.data.VisualPromptingConfig</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mem_cache_size:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'1GB'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mem_cache_img_max_size:</span> <span class="pre">tuple[int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int]</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_color_channel:</span> <span class="pre">~otx.core.types.image.ImageColorChannel</span> <span class="pre">=</span> <span class="pre">ImageColorChannel.RGB</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stack_images:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_polygons:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_index:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">255</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unannotated_items_ratio:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_num_workers:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device:</span> <span class="pre">~otx.core.types.device.DeviceType</span> <span class="pre">=</span> <span class="pre">DeviceType.auto</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/otx/core/config/data.html#DataModuleConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#otx.core.config.data.DataModuleConfig" 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>DTO for data module configuration.</p>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 9c23fab

Please sign in to comment.