draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  6. <title>draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder &#8212; Draugr 1.0.1 documentation</title>
  7. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  8. <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
  9. <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
  10. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  11. <script src="../_static/jquery.js"></script>
  12. <script src="../_static/underscore.js"></script>
  13. <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
  14. <script src="../_static/doctools.js"></script>
  15. <link rel="canonical" href="pything.github.io/draugr/generated/draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.html" />
  16. <link rel="index" title="Index" href="../genindex.html" />
  17. <link rel="search" title="Search" href="../search.html" />
  18. <link rel="next" title="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder" href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder.html" />
  19. <link rel="prev" title="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset" href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.html" />
  20. <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  21. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  22. </head><body>
  23. <div class="document">
  24. <div class="documentwrapper">
  25. <div class="bodywrapper">
  26. <div class="body" role="main">
  27. <section id="draugr-torch-utilities-datasets-supervised-vision-datasets-dict-dataset-dictdatasetfolder">
  28. <h1>draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder<a class="headerlink" href="#draugr-torch-utilities-datasets-supervised-vision-datasets-dict-dataset-dictdatasetfolder" title="Permalink to this heading">¶</a></h1>
  29. <dl class="py class">
  30. <dt class="sig sig-object py" id="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder">
  31. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.</span></span><span class="sig-name descname"><span class="pre">DictDatasetFolder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root:</span> <span class="pre">~pathlib.Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loader:</span> <span class="pre">~torch.utils.data.dataloader.DataLoader</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extensions:</span> <span class="pre">~typing.Optional[~typing.Iterable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_transform:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_valid_file:</span> <span class="pre">callable</span> <span class="pre">=</span> <span class="pre">&lt;function</span> <span class="pre">has_file_allowed_extension&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/datasets/supervised/vision_datasets/dict_dataset.html#DictDatasetFolder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder" title="Permalink to this definition">¶</a></dt>
  32. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VisionDataset</span></code></p>
  33. <p>A generic data loader where the samples are arranged in this way:</p>
  34. <p>root/class_x/xxx.ext
  35. root/class_x/xxy.ext
  36. root/class_x/xxz.ext</p>
  37. <p>root/class_y/123.ext
  38. root/class_y/nsdf3.ext
  39. root/class_y/<a href="#id1"><span class="problematic" id="id2">asd932_</span></a>.ext</p>
  40. <p>Args:
  41. root (string): Root directory path.
  42. loader (callable): A function to load a sample given its path.
  43. extensions (tuple[string]): A list of allowed extensions.</p>
  44. <blockquote>
  45. <div><p>both extensions and is_valid_file should not be passed.</p>
  46. </div></blockquote>
  47. <dl class="simple">
  48. <dt>transform (callable, optional): A function/transform that takes in</dt><dd><p>a sample and returns a transformed version.
  49. E.g, <code class="docutils literal notranslate"><span class="pre">transforms.RandomCrop</span></code> for images.</p>
  50. </dd>
  51. <dt>target_transform (callable, optional): A function/transform that takes</dt><dd><p>in the target and transforms it.</p>
  52. </dd>
  53. <dt>is_valid_file (callable, optional): A function that takes path of a file</dt><dd><p>and check if the file is a valid file (used to check of corrupt files)
  54. both extensions and is_valid_file should not be passed.</p>
  55. </dd>
  56. </dl>
  57. <p>Attributes:
  58. _categories (list): List of the class names sorted alphabetically.
  59. _data (list): List of (sample path, class_index) tuples</p>
  60. <dl class="py method">
  61. <dt class="sig sig-object py" id="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.__init__">
  62. <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">root:</span> <span class="pre">~pathlib.Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loader:</span> <span class="pre">~torch.utils.data.dataloader.DataLoader</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extensions:</span> <span class="pre">~typing.Optional[~typing.Iterable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transform:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_transform:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_valid_file:</span> <span class="pre">callable</span> <span class="pre">=</span> <span class="pre">&lt;function</span> <span class="pre">has_file_allowed_extension&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/datasets/supervised/vision_datasets/dict_dataset.html#DictDatasetFolder.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.__init__" title="Permalink to this definition">¶</a></dt>
  63. <dd></dd></dl>
  64. <p class="rubric">Methods</p>
  65. <table class="autosummary longtable docutils align-default">
  66. <colgroup>
  67. <col style="width: 10%" />
  68. <col style="width: 90%" />
  69. </colgroup>
  70. <tbody>
  71. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.__init__" title="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(root, loader[, extensions, ...])</p></td>
  72. <td><p></p></td>
  73. </tr>
  74. <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">extra_repr</span></code>()</p></td>
  75. <td><p></p></td>
  76. </tr>
  77. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.sample" title="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.sample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample</span></code></a>(target, index)</p></td>
  78. <td><p>description</p></td>
  79. </tr>
  80. </tbody>
  81. </table>
  82. <dl class="py method">
  83. <dt class="sig sig-object py" id="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.sample">
  84. <span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a></span></span><a class="reference internal" href="../_modules/draugr/torch_utilities/datasets/supervised/vision_datasets/dict_dataset.html#DictDatasetFolder.sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.sample" title="Permalink to this definition">¶</a></dt>
  85. <dd><p>description</p>
  86. </dd></dl>
  87. </dd></dl>
  88. </section>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  93. <div class="sphinxsidebarwrapper">
  94. <p class="logo"><a href="../index.html">
  95. <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
  96. </a></p>
  97. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
  98. <h3>Navigation</h3>
  99. <ul class="current">
  100. <li class="toctree-l1 current"><a class="reference internal" href="draugr.html">draugr</a><ul class="current">
  101. <li class="toctree-l2"><a class="reference internal" href="draugr.dist_is_editable.html">draugr.dist_is_editable</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="draugr.get_version.html">draugr.get_version</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="draugr.dlib_utilities.html">draugr.dlib_utilities</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="draugr.drawers.html">draugr.drawers</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="draugr.entry_points.html">draugr.entry_points</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="draugr.extensions.html">draugr.extensions</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="draugr.ffmpeg_utilities.html">draugr.ffmpeg_utilities</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="draugr.jax_utilities.html">draugr.jax_utilities</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="draugr.metrics.html">draugr.metrics</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="draugr.multiprocessing_utilities.html">draugr.multiprocessing_utilities</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="draugr.numpy_utilities.html">draugr.numpy_utilities</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="draugr.opencv_utilities.html">draugr.opencv_utilities</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="draugr.os_utilities.html">draugr.os_utilities</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="draugr.pandas_utilities.html">draugr.pandas_utilities</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="draugr.pygame_utilities.html">draugr.pygame_utilities</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="draugr.python_utilities.html">draugr.python_utilities</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="draugr.random_utilities.html">draugr.random_utilities</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="draugr.scipy_utilities.html">draugr.scipy_utilities</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="draugr.stopping.html">draugr.stopping</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="draugr.tensorboard_utilities.html">draugr.tensorboard_utilities</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="draugr.threading_utilities.html">draugr.threading_utilities</a></li>
  122. <li class="toctree-l2 current"><a class="reference internal" href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul class="current">
  123. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a></li>
  124. <li class="toctree-l3 current"><a class="reference internal" href="draugr.torch_utilities.datasets.html">draugr.torch_utilities.datasets</a><ul class="current">
  125. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.datasets.non_sequential_dataset.html">draugr.torch_utilities.datasets.non_sequential_dataset</a></li>
  126. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.datasets.random_dataset.html">draugr.torch_utilities.datasets.random_dataset</a></li>
  127. <li class="toctree-l4 current"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.html">draugr.torch_utilities.datasets.supervised</a><ul class="current">
  128. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.categorical_dataset.html">draugr.torch_utilities.datasets.supervised.categorical_dataset</a></li>
  129. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.supervised_dataset.html">draugr.torch_utilities.datasets.supervised.supervised_dataset</a></li>
  130. <li class="toctree-l5 current"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.vision_datasets.html">draugr.torch_utilities.datasets.supervised.vision_datasets</a><ul class="current">
  131. <li class="toctree-l6 current"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.html">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset</a><ul class="current">
  132. <li class="toctree-l7 current"><a class="current reference internal" href="#">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder</a></li>
  133. <li class="toctree-l7"><a class="reference internal" href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder.html">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder</a></li>
  134. </ul>
  135. </li>
  136. </ul>
  137. </li>
  138. </ul>
  139. </li>
  140. </ul>
  141. </li>
  142. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.distributions.html">draugr.torch_utilities.distributions</a></li>
  143. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.evaluation.html">draugr.torch_utilities.evaluation</a></li>
  144. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.exporting.html">draugr.torch_utilities.exporting</a></li>
  145. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.generators.html">draugr.torch_utilities.generators</a></li>
  146. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.images.html">draugr.torch_utilities.images</a></li>
  147. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.opencv.html">draugr.torch_utilities.opencv</a></li>
  148. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.operations.html">draugr.torch_utilities.operations</a></li>
  149. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.optimisation.html">draugr.torch_utilities.optimisation</a></li>
  150. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.persistence.html">draugr.torch_utilities.persistence</a></li>
  151. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.sessions.html">draugr.torch_utilities.sessions</a></li>
  152. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.system.html">draugr.torch_utilities.system</a></li>
  153. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.tensors.html">draugr.torch_utilities.tensors</a></li>
  154. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.writers.html">draugr.torch_utilities.writers</a></li>
  155. </ul>
  156. </li>
  157. <li class="toctree-l2"><a class="reference internal" href="draugr.tqdm_utilities.html">draugr.tqdm_utilities</a></li>
  158. <li class="toctree-l2"><a class="reference internal" href="draugr.visualisation.html">draugr.visualisation</a></li>
  159. <li class="toctree-l2"><a class="reference internal" href="draugr.writers.html">draugr.writers</a></li>
  160. </ul>
  161. </li>
  162. </ul>
  163. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
  164. <ul>
  165. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
  166. </ul>
  167. <div class="relations">
  168. <h3>Related Topics</h3>
  169. <ul>
  170. <li><a href="../index.html">Documentation overview</a><ul>
  171. <li><a href="draugr.html">draugr</a><ul>
  172. <li><a href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul>
  173. <li><a href="draugr.torch_utilities.datasets.html">draugr.torch_utilities.datasets</a><ul>
  174. <li><a href="draugr.torch_utilities.datasets.supervised.html">draugr.torch_utilities.datasets.supervised</a><ul>
  175. <li><a href="draugr.torch_utilities.datasets.supervised.vision_datasets.html">draugr.torch_utilities.datasets.supervised.vision_datasets</a><ul>
  176. <li><a href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.html">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset</a><ul>
  177. <li>Previous: <a href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.html" title="previous chapter">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset</a></li>
  178. <li>Next: <a href="draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder.html" title="next chapter">draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.SplitDictDatasetFolder</a></li>
  179. </ul></li>
  180. </ul></li>
  181. </ul></li>
  182. </ul></li>
  183. </ul></li>
  184. </ul></li>
  185. </ul></li>
  186. </ul>
  187. </div>
  188. <div id="searchbox" style="display: none" role="search">
  189. <h3 id="searchlabel">Quick search</h3>
  190. <div class="searchformwrapper">
  191. <form class="search" action="../search.html" method="get">
  192. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  193. <input type="submit" value="Go" />
  194. </form>
  195. </div>
  196. </div>
  197. <script>document.getElementById('searchbox').style.display = "block"</script>
  198. </div>
  199. </div>
  200. <div class="clearer"></div>
  201. </div>
  202. <div class="footer">
  203. &copy;.
  204. |
  205. Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
  206. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
  207. |
  208. <a href="../_sources/generated/draugr.torch_utilities.datasets.supervised.vision_datasets.dict_dataset.DictDatasetFolder.rst.txt"
  209. rel="nofollow">Page source</a>
  210. </div>
  211. </body>
  212. </html>