Bump version to 0.0.26 and update documentation [skip ci]

Author: github-actions[bot]

docs/_build/html/RemotePathDataLoader.html

@@ -44,6 +44,26 @@ <h3>Navigation</h3>
 
   <section id="remotepathdataloader">
 <h1>RemotePathDataLoader<a class="headerlink" href="#remotepathdataloader" title="Link to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyremotedata.dataloader.</span></span><span class="sig-name descname"><span class="pre">RemotePathDataLoader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RemotePathDataset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shuffle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DataLoader</span></code></p>
+<p>A custom DataLoader for RemotePathDatasets.</p>
+<p>This DataLoader is designed to work with RemotePathDatasets and does not support all the arguments of the standard DataLoader.</p>
+<p>Unsupported arguments:
+- sampler
+- batch_sampler</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>dataset</strong> (<em>RemotePathDataset</em>) – The <cite>RemotePathDataset</cite> dataset to load from.</p></li>
+<li><p><strong>num_workers</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of worker threads to use for loading. Default: 0. Must be greater than 0.</p></li>
+<li><p><strong>shuffle</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to shuffle the dataset between epochs. Default: False.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 
 

docs/_build/html/RemotePathDataset.html

@@ -48,6 +48,37 @@ <h3>Navigation</h3>
 
   <section id="remotepathdataset">
 <h1>RemotePathDataset<a class="headerlink" href="#remotepathdataset" title="Link to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyremotedata.dataloader.</span></span><span class="sig-name descname"><span class="pre">RemotePathDataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remote_path_iterator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RemotePathIterator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefetch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_transform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">device</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dtype</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hierarchical</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hierarchy_parser</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shuffle</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_remote_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_local_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">IterableDataset</span></code></p>
+<p>Creates a PyTorch dataset from a RemotePathIterator.</p>
+<p>By default the dataset will return the image as a tensor and the remote path as a string.</p>
+<p>### Hierarchical mode
+If <cite>hierarchical</cite> &gt;= 1, the dataset is in “Hierarchical mode” and will return the image as a tensor and the label as a list of integers (class indices for each level in the hierarchy).</p>
+<p>The <cite>class_handles</cite> property can be used to get the class-idx mappings for the dataset.</p>
+<p>By default the dataset will use a parser which assumes that the hierarchical levels are encoded in the remote path as directories like so:</p>
+<p><cite>…/level_n/…/level_1/level_0/image.jpg</cite></p>
+<p>Where <cite>n = (hierarchical - 1)</cite> and <cite>level_0</cite> is the leaf level.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>remote_path_iterator</strong> (<em>RemotePathIterator</em>) – The remote path iterator to create the dataset from.</p></li>
+<li><p><strong>prefetch</strong> (<em>int</em>) – The number of items to prefetch from the remote path iterator.</p></li>
+<li><p><strong>transform</strong> (<em>callable</em><em>, </em><em>optional</em>) – A function/transform that takes in an image as a <cite>torch.Tensor</cite> and returns a transformed version.</p></li>
+<li><p><strong>target_transform</strong> (<em>callable</em><em>, </em><em>optional</em>) – A function/transform that takes in the label (after potential parsing by <cite>parse_hierarchical</cite>) and transforms it.</p></li>
+<li><p><strong>device</strong> (<em>torch.device</em><em>, </em><em>optional</em>) – The device to move the tensors to.</p></li>
+<li><p><strong>dtype</strong> (<em>torch.dtype</em><em>, </em><em>optional</em>) – The data type to convert the tensors to.</p></li>
+<li><p><strong>hierarchical</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of hierarchical levels to use for the labels. Default: 0, i.e. no hierarchy.</p></li>
+<li><p><strong>hierarchy_parser</strong> (<em>callable</em><em>, </em><em>optional</em>) – A function to parse the hierarchical levels from the remote path. Default: None, i.e. use the default parser.</p></li>
+<li><p><strong>return_remote_path</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to return the remote path. Default: False.</p></li>
+<li><p><strong>return_local_path</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to return the local path. Default: False.</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to print verbose output. Default: False.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 
 

docs/_build/html/dataloader.html

@@ -48,8 +48,11 @@ <h3>Navigation</h3>
   <section id="pytorch-integration">
 <h1>PyTorch Integration<a class="headerlink" href="#pytorch-integration" title="Link to this heading">¶</a></h1>
 <p>Includes a PyTorch IterableDataset and IterableDataLoader for loading data from a remote SFTP server through the pyremotedata.RemotePathIterator class.</p>
-<section id="description">
-<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
+<section id="module-pyremotedata.dataloader">
+<span id="description"></span><h2>Description<a class="headerlink" href="#module-pyremotedata.dataloader" title="Link to this heading">¶</a></h2>
+<section id="contents">
+<h3>Contents<a class="headerlink" href="#contents" title="Link to this heading">¶</a></h3>
+</section>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
@@ -71,7 +74,10 @@ <h2>Description<a class="headerlink" href="#description" title="Link to this hea
     <h3><a href="index.html">Table of Contents</a></h3>
     <ul>
 <li><a class="reference internal" href="#">PyTorch Integration</a><ul>
-<li><a class="reference internal" href="#description">Description</a></li>
+<li><a class="reference internal" href="#module-pyremotedata.dataloader">Description</a><ul>
+<li><a class="reference internal" href="#contents">Contents</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>

docs/_build/html/genindex.html

@@ -103,6 +103,8 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="config.html#module-pyremotedata.config">pyremotedata.config</a>
+</li>
+        <li><a href="dataloader.html#module-pyremotedata.dataloader">pyremotedata.dataloader</a>
 </li>
         <li><a href="implicit_mount.html#module-pyremotedata.implicit_mount">pyremotedata.implicit_mount</a>
 </li>
@@ -118,6 +120,13 @@ <h2 id="P">P</h2>
 
       <ul>
         <li><a href="config.html#module-pyremotedata.config">module</a>
+</li>
+      </ul></li>
+      <li>
+    pyremotedata.dataloader
+
+      <ul>
+        <li><a href="dataloader.html#module-pyremotedata.dataloader">module</a>
 </li>
       </ul></li>
   </ul></td>

docs/_build/html/objects.inv

@@ -2,5 +2,5 @@
 # Project: PyRemoteData
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڭ��N�0��<E�^ٸ�=�1�������Y [Z�Fn�����R����z���t��D`�"�b[d�jV�d5rI\h�c��]0� aP�c�wI�AY~[�)�r�pu����ϡP��������aPQ�!�*�3�N�ma��%e�N�)ʊi�I)kqbO�`�y��;�����S-�X�[���
-��&kd+&S.�O�M�Y�ɺ��3}��~l�͂ߘ���[��)}�Հ�A#�S��(��՞�&��zc&���n���=����u`�l�Js	��#3�`��r���du\d_�_��ՙ�K�t���Mw X0T���x*K (Mn$v�_�����m�g�ُ�^�&��v;���#X�`nVzDk�v`#�źS:=��~�
+xڭ��N�0��<E�^ٸ�=�1�������Y [Z�Fn�����R��YO��|�Lg�T��R"0�t�J�-2R5�R��9'δȱ����0���ջ�֠,��E��d9R8��GRQ���
+(B�`Kk��p�?�0��ҐP��xG䶰��2P��eŋ�����8���������f�C7G=�^�qGcמLtwC�&�F�b2%�|�pՉ�[y?�w���ma��W��[w,��O��0h��T��(��zo�u��b�)�G��l���oN�mL$n6R�9�B֑�B0xm9N��[��:.����azy&fI�71����=1�?
Oe	��ϵ�v���]]� �-�$0�1QkՄ��)�ݎ��=�/X�`nnĈ�@m�F��u�t��f|��-�

docs/_build/html/py-modindex.html

@@ -61,6 +61,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="config.html#module-pyremotedata.config"><code class="xref">pyremotedata.config</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="dataloader.html#module-pyremotedata.dataloader"><code class="xref">pyremotedata.dataloader</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;