Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel
Resources  
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Explore Pricing
Product  
Data Engine LLMs Platform Enterprise
Connect to Dagshub Discord channel
Register
Login

Deci-AI
/
super-gradients
connected to https://github.com/Deci-AI/super-gradients.git

Watch 4
Issues 62 Pull Requests 44 Discussions 0

#396 Trainer constructor cleanup

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:feature/SG-266_clean_trainer_ctor
Conversation 0 Files changed 49 Commits 1
File Compare
super-gradients
/
docs
/
super_gradients.training.datasets.dataset_interfaces.html
View left file View right file
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512 
  1. <!DOCTYPE html>
    2. 

  2. <html class="writer-html5" lang="en" >
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
    5. 

  5. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <title>super_gradients.training.datasets.dataset_interfaces package &mdash; SuperGradients 1.0 documentation</title>
    8. 

  8.       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    9. 

  9.       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    10. 

  10.       <link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
    11. 

  11.   <!--[if lt IE 9]>
    12. 

  12.     <script src="_static/js/html5shiv.min.js"></script>
    13. 

  13.   <![endif]-->
    14. 

  14.   
    15. 

  15.         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
    16. 

  16.         <script src="_static/jquery.js"></script>
    17. 

  17.         <script src="_static/underscore.js"></script>
    18. 

  18.         <script src="_static/doctools.js"></script>
    19. 

  19.     <script src="_static/js/theme.js"></script>
    20. 

  20.     <link rel="index" title="Index" href="genindex.html" />
    21. 

  21.     <link rel="search" title="Search" href="search.html" /> 
    22. 

  22. </head>
    23. 

  23. 

  24. <body class="wy-body-for-nav"> 
    25. 

  25.   <div class="wy-grid-for-nav">
    26. 

  26.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    27. 

  27.       <div class="wy-side-scroll">
    28. 

  28.         <div class="wy-side-nav-search" >
    29. 

  29.             <a href="index.html" class="icon icon-home"> SuperGradients
    30. 

  30.           </a>
    31. 

  31. <div role="search">
    32. 

  32.   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    33. 

  33.     <input type="text" name="q" placeholder="Search docs" />
    34. 

  34.     <input type="hidden" name="check_keywords" value="yes" />
    35. 

  35.     <input type="hidden" name="area" value="default" />
    36. 

  36.   </form>
    37. 

  37. </div>
    38. 

  38.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    39. 

  39.               <p class="caption"><span class="caption-text">Welcome To SuperGradients</span></p>
    40. 

  40. <ul>
    41. 

  41. <li class="toctree-l1"><a class="reference internal" href="welcome.html">Fill our 4-question quick survey! We will raffle free SuperGradients swag between those who will participate -&gt; Fill Survey</a></li>
    42. 

  42. <li class="toctree-l1"><a class="reference internal" href="welcome.html#supergradients">SuperGradients</a></li>
    43. 

  43. </ul>
    44. 

  44. <p class="caption"><span class="caption-text">Technical Documentation</span></p>
    45. 

  45. <ul>
    46. 

  46. <li class="toctree-l1"><a class="reference internal" href="super_gradients.common.html">Common package</a></li>
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="super_gradients.training.html">Training package</a></li>
    48. 

  48. </ul>
    49. 

  49. <p class="caption"><span class="caption-text">User Guide</span></p>
    50. 

  50. <ul>
    51. 

  51. <li class="toctree-l1"><a class="reference internal" href="user_guide.html">What is SuperGradients?</a></li>
    52. 

  52. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#introducing-the-supergradients-library">Introducing the SuperGradients library</a></li>
    53. 

  53. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#installation">Installation</a></li>
    54. 

  54. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough">Integrating Your Training Code - Complete Walkthrough</a></li>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#training-parameters">Training Parameters</a></li>
    56. 

  56. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#logs-and-checkpoints">Logs and Checkpoints</a></li>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#dataset-parameters">Dataset Parameters</a></li>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#network-architectures">Network Architectures</a></li>
    59. 

  59. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#pretrained-models">Pretrained Models</a></li>
    60. 

  60. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#how-to-reproduce-our-training-recipes">How To Reproduce Our Training Recipes</a></li>
    61. 

  61. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#professional-tools-integration">Professional Tools Integration</a></li>
    62. 

  62. <li class="toctree-l1"><a class="reference internal" href="user_guide.html#supergradients-faq">SuperGradients FAQ</a></li>
    63. 

  63. </ul>
    64. 

  64. 

  65.         </div>
    66. 

  66.       </div>
    67. 

  67.     </nav>
    68. 

  68. 

  69.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
    70. 

  70.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    71. 

  71.           <a href="index.html">SuperGradients</a>
    72. 

  72.       </nav>
    73. 

  73. 

  74.       <div class="wy-nav-content">
    75. 

  75.         <div class="rst-content">
    76. 

  76.           <div role="navigation" aria-label="Page navigation">
    77. 

  77.   <ul class="wy-breadcrumbs">
    78. 

  78.       <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
    79. 

  79.       <li>super_gradients.training.datasets.dataset_interfaces package</li>
    80. 

  80.       <li class="wy-breadcrumbs-aside">
    81. 

  81.             <a href="_sources/super_gradients.training.datasets.dataset_interfaces.rst.txt" rel="nofollow"> View page source</a>
    82. 

  82.       </li>
    83. 

  83.   </ul>
    84. 

  84.   <hr/>
    85. 

  85. </div>
    86. 

  86.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    87. 

  87.            <div itemprop="articleBody">
    88. 

  88.              
    89. 

  89.   <section id="super-gradients-training-datasets-dataset-interfaces-package">
    90. 

  90. <h1>super_gradients.training.datasets.dataset_interfaces package<a class="headerlink" href="#super-gradients-training-datasets-dataset-interfaces-package" title="Permalink to this headline"></a></h1>
    91. 

  91. <section id="submodules">
    92. 

  92. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
    93. 

  93. </section>
    94. 

  94. <section id="module-super_gradients.training.datasets.dataset_interfaces.dataset_interface">
    95. 

  95. <span id="super-gradients-training-datasets-dataset-interfaces-dataset-interface-module"></span><h2>super_gradients.training.datasets.dataset_interfaces.dataset_interface module<a class="headerlink" href="#module-super_gradients.training.datasets.dataset_interfaces.dataset_interface" title="Permalink to this headline"></a></h2>
    96. 

  96. <dl class="py class">
    97. 

  97. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface">
    98. 

  98. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="Permalink to this definition"></a></dt>
    99. 

  99. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    100. 

  100. <p>DatasetInterface - This class manages all of the “communiation” the Model has with the Data Sets</p>
    101. 

  101. <dl class="py method">
    102. 

  102. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.download_from_cloud">
    103. 

  103. <span class="sig-name descname"><span class="pre">download_from_cloud</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.download_from_cloud"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.download_from_cloud" title="Permalink to this definition"></a></dt>
    104. 

  104. <dd></dd></dl>
    105. 

  105. 

  106. <dl class="py method">
    107. 

  107. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.build_data_loaders">
    108. 

  108. <span class="sig-name descname"><span class="pre">build_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.build_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.build_data_loaders" title="Permalink to this definition"></a></dt>
    109. 

  109. <dd><p>define train, val (and optionally test) loaders. The method deals separately with distributed training and standard
    110. 

  110. (non distributed, or parallel training). In the case of distributed training we need to rely on distributed
    111. 

  111. samplers.
    112. 

  112. :param batch_size_factor: int - factor to multiply the batch size (usually for multi gpu)
    113. 

  113. :param num_workers: int - number of workers (parallel processes) for dataloaders
    114. 

  114. :param train_batch_size: int - batch size for train loader, if None will be taken from dataset_params
    115. 

  115. :param val_batch_size: int - batch size for val loader, if None will be taken from dataset_params
    116. 

  116. :param distributed_sampler: boolean flag for distributed training mode
    117. 

  117. :return: train_loader, val_loader, classes: list of classes</p>
    118. 

  118. </dd></dl>
    119. 

  119. 

  120. <dl class="py method">
    121. 

  121. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_data_loaders">
    122. 

  122. <span class="sig-name descname"><span class="pre">get_data_loaders</span></span><span class="sig-paren">(</span><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><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_data_loaders" title="Permalink to this definition"></a></dt>
    123. 

  123. <dd><p>Get self.train_loader, self.val_loader, self.test_loader, self.classes.</p>
    124. 

  124. <p>If the data loaders haven’t been initialized yet, build them first.</p>
    125. 

  125. <dl class="field-list simple">
    126. 

  126. <dt class="field-odd">Parameters</dt>
    127. 

  127. <dd class="field-odd"><p><strong>kwargs</strong> – kwargs are passed to build_data_loaders.</p>
    128. 

  128. </dd>
    129. 

  129. </dl>
    130. 

  130. </dd></dl>
    131. 

  131. 

  132. <dl class="py method">
    133. 

  133. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_val_sample">
    134. 

  134. <span class="sig-name descname"><span class="pre">get_val_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_samples</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_val_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_val_sample" title="Permalink to this definition"></a></dt>
    135. 

  135. <dd></dd></dl>
    136. 

  136. 

  137. <dl class="py method">
    138. 

  138. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_dataset_params">
    139. 

  139. <span class="sig-name descname"><span class="pre">get_dataset_params</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_dataset_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.get_dataset_params" title="Permalink to this definition"></a></dt>
    140. 

  140. <dd></dd></dl>
    141. 

  141. 

  142. <dl class="py method">
    143. 

  143. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.print_dataset_details">
    144. 

  144. <span class="sig-name descname"><span class="pre">print_dataset_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.print_dataset_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface.print_dataset_details" title="Permalink to this definition"></a></dt>
    145. 

  145. <dd></dd></dl>
    146. 

  146. 

  147. </dd></dl>
    148. 

  148. 

  149. <dl class="py class">
    150. 

  150. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.ExternalDatasetInterface">
    151. 

  151. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">ExternalDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">train_loader</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_loader</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_classes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ExternalDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.ExternalDatasetInterface" title="Permalink to this definition"></a></dt>
    152. 

  152. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    153. 

  153. <dl class="py method">
    154. 

  154. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.ExternalDatasetInterface.get_data_loaders">
    155. 

  155. <span class="sig-name descname"><span class="pre">get_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">1</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="n"><span class="pre">int</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ExternalDatasetInterface.get_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.ExternalDatasetInterface.get_data_loaders" title="Permalink to this definition"></a></dt>
    156. 

  156. <dd><p>Get self.train_loader, self.val_loader, self.test_loader, self.classes.</p>
    157. 

  157. <p>If the data loaders haven’t been initialized yet, build them first.</p>
    158. 

  158. <dl class="field-list simple">
    159. 

  159. <dt class="field-odd">Parameters</dt>
    160. 

  160. <dd class="field-odd"><p><strong>kwargs</strong> – kwargs are passed to build_data_loaders.</p>
    161. 

  161. </dd>
    162. 

  162. </dl>
    163. 

  163. </dd></dl>
    164. 

  164. 

  165. </dd></dl>
    166. 

  166. 

  167. <dl class="py class">
    168. 

  168. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface">
    169. 

  169. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">LibraryDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cifar10'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_cutout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#LibraryDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface" title="Permalink to this definition"></a></dt>
    170. 

  170. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    171. 

  171. </dd></dl>
    172. 

  172. 

  173. <dl class="py class">
    174. 

  174. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.Cifar10DatasetInterface">
    175. 

  175. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">Cifar10DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#Cifar10DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.Cifar10DatasetInterface" title="Permalink to this definition"></a></dt>
    176. 

  176. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface</span></code></a></p>
    177. 

  177. </dd></dl>
    178. 

  178. 

  179. <dl class="py class">
    180. 

  180. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.Cifar100DatasetInterface">
    181. 

  181. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">Cifar100DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#Cifar100DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.Cifar100DatasetInterface" title="Permalink to this definition"></a></dt>
    182. 

  182. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface</span></code></a></p>
    183. 

  183. </dd></dl>
    184. 

  184. 

  185. <dl class="py class">
    186. 

  186. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface">
    187. 

  187. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">TestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trainset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="Permalink to this definition"></a></dt>
    188. 

  188. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    189. 

  189. <dl class="py method">
    190. 

  190. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface.get_data_loaders">
    191. 

  191. <span class="sig-name descname"><span class="pre">get_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestDatasetInterface.get_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface.get_data_loaders" title="Permalink to this definition"></a></dt>
    192. 

  192. <dd><p>Get self.train_loader, self.val_loader, self.test_loader, self.classes.</p>
    193. 

  193. <p>If the data loaders haven’t been initialized yet, build them first.</p>
    194. 

  194. <dl class="field-list simple">
    195. 

  195. <dt class="field-odd">Parameters</dt>
    196. 

  196. <dd class="field-odd"><p><strong>kwargs</strong> – kwargs are passed to build_data_loaders.</p>
    197. 

  197. </dd>
    198. 

  198. </dl>
    199. 

  199. </dd></dl>
    200. 

  200. 

  201. </dd></dl>
    202. 

  202. 

  203. <dl class="py class">
    204. 

  204. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.ClassificationTestDatasetInterface">
    205. 

  205. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">ClassificationTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ClassificationTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.ClassificationTestDatasetInterface" title="Permalink to this definition"></a></dt>
    206. 

  206. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    207. 

  207. </dd></dl>
    208. 

  208. 

  209. <dl class="py class">
    210. 

  210. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.SegmentationTestDatasetInterface">
    211. 

  211. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">SegmentationTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">512</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#SegmentationTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.SegmentationTestDatasetInterface" title="Permalink to this definition"></a></dt>
    212. 

  212. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    213. 

  213. </dd></dl>
    214. 

  214. 

  215. <dl class="py class">
    216. 

  216. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionTestDatasetInterface">
    217. 

  217. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">DetectionTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">320</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DetectionTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionTestDatasetInterface" title="Permalink to this definition"></a></dt>
    218. 

  218. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    219. 

  219. </dd></dl>
    220. 

  220. 

  221. <dl class="py class">
    222. 

  222. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestYoloDetectionDatasetInterface">
    223. 

  223. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">TestYoloDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(3,</span> <span class="pre">32,</span> <span class="pre">32)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestYoloDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestYoloDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    224. 

  224. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    225. 

  225. <p>note: the output size is (batch_size, 6) in the test while in real training
    226. 

  226. the size of axis 0 can vary (the number of bounding boxes)</p>
    227. 

  227. </dd></dl>
    228. 

  228. 

  229. <dl class="py class">
    230. 

  230. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.ImageNetDatasetInterface">
    231. 

  231. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">ImageNetDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/data/Imagenet'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ImageNetDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.ImageNetDatasetInterface" title="Permalink to this definition"></a></dt>
    232. 

  232. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    233. 

  233. </dd></dl>
    234. 

  234. 

  235. <dl class="py class">
    236. 

  236. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TinyImageNetDatasetInterface">
    237. 

  237. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">TinyImageNetDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/data/TinyImagenet'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TinyImageNetDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TinyImageNetDatasetInterface" title="Permalink to this definition"></a></dt>
    238. 

  238. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    239. 

  239. </dd></dl>
    240. 

  240. 

  241. <dl class="py class">
    242. 

  242. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.ClassificationDatasetInterface">
    243. 

  243. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">ClassificationDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">normalization_mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalization_std</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(1,</span> <span class="pre">1,</span> <span class="pre">1)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ClassificationDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.ClassificationDatasetInterface" title="Permalink to this definition"></a></dt>
    244. 

  244. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    245. 

  245. </dd></dl>
    246. 

  246. 

  247. <dl class="py class">
    248. 

  248. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalVOC2012SegmentationDataSetInterface">
    249. 

  249. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">PascalVOC2012SegmentationDataSetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalVOC2012SegmentationDataSetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalVOC2012SegmentationDataSetInterface" title="Permalink to this definition"></a></dt>
    250. 

  250. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    251. 

  251. </dd></dl>
    252. 

  252. 

  253. <dl class="py class">
    254. 

  254. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalAUG2012SegmentationDataSetInterface">
    255. 

  255. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">PascalAUG2012SegmentationDataSetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalAUG2012SegmentationDataSetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalAUG2012SegmentationDataSetInterface" title="Permalink to this definition"></a></dt>
    256. 

  256. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    257. 

  257. </dd></dl>
    258. 

  258. 

  259. <dl class="py class">
    260. 

  260. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase">
    261. 

  261. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">CoCoDataSetInterfaceBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CoCoDataSetInterfaceBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase" title="Permalink to this definition"></a></dt>
    262. 

  262. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    263. 

  263. </dd></dl>
    264. 

  264. 

  265. <dl class="py class">
    266. 

  266. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoSegmentationDatasetInterface">
    267. 

  267. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">CoCoSegmentationDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_classes_inclusion_tuples_list</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CoCoSegmentationDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoSegmentationDatasetInterface" title="Permalink to this definition"></a></dt>
    268. 

  268. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase</span></code></a></p>
    269. 

  269. </dd></dl>
    270. 

  270. 

  271. <dl class="py class">
    272. 

  272. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CityscapesDatasetInterface">
    273. 

  273. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">CityscapesDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CityscapesDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CityscapesDatasetInterface" title="Permalink to this definition"></a></dt>
    274. 

  274. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    275. 

  275. </dd></dl>
    276. 

  276. 

  277. <dl class="py class">
    278. 

  278. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.SuperviselyPersonsDatasetInterface">
    279. 

  279. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">SuperviselyPersonsDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#SuperviselyPersonsDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.SuperviselyPersonsDatasetInterface" title="Permalink to this definition"></a></dt>
    280. 

  280. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    281. 

  281. </dd></dl>
    282. 

  282. 

  283. <dl class="py class">
    284. 

  284. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface">
    285. 

  285. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">DetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    286. 

  286. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    287. 

  287. <dl class="py method">
    288. 

  288. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface.build_data_loaders">
    289. 

  289. <span class="sig-name descname"><span class="pre">build_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DetectionDatasetInterface.build_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface.build_data_loaders" title="Permalink to this definition"></a></dt>
    290. 

  290. <dd><p>define train, val (and optionally test) loaders. The method deals separately with distributed training and standard
    291. 

  291. (non distributed, or parallel training). In the case of distributed training we need to rely on distributed
    292. 

  292. samplers.
    293. 

  293. :param batch_size_factor: int - factor to multiply the batch size (usually for multi gpu)
    294. 

  294. :param num_workers: int - number of workers (parallel processes) for dataloaders
    295. 

  295. :param train_batch_size: int - batch size for train loader, if None will be taken from dataset_params
    296. 

  296. :param val_batch_size: int - batch size for val loader, if None will be taken from dataset_params
    297. 

  297. :param distributed_sampler: boolean flag for distributed training mode
    298. 

  298. :return: train_loader, val_loader, classes: list of classes</p>
    299. 

  299. </dd></dl>
    300. 

  300. 

  301. </dd></dl>
    302. 

  302. 

  303. <dl class="py class">
    304. 

  304. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalVOCUnifiedDetectionDatasetInterface">
    305. 

  305. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">PascalVOCUnifiedDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalVOCUnifiedDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.PascalVOCUnifiedDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    306. 

  306. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface</span></code></a></p>
    307. 

  307. </dd></dl>
    308. 

  308. 

  309. <dl class="py class">
    310. 

  310. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDetectionDatasetInterface">
    311. 

  311. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.</span></span><span class="sig-name descname"><span class="pre">CoCoDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CoCoDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    312. 

  312. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface</span></code></a></p>
    313. 

  313. </dd></dl>
    314. 

  314. 

  315. </section>
    316. 

  316. <section id="module-super_gradients.training.datasets.dataset_interfaces">
    317. 

  317. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-super_gradients.training.datasets.dataset_interfaces" title="Permalink to this headline"></a></h2>
    318. 

  318. <dl class="py class">
    319. 

  319. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface">
    320. 

  320. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_loader</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface" title="Permalink to this definition"></a></dt>
    321. 

  321. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
    322. 

  322. <p>DatasetInterface - This class manages all of the “communiation” the Model has with the Data Sets</p>
    323. 

  323. <dl class="py method">
    324. 

  324. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.download_from_cloud">
    325. 

  325. <span class="sig-name descname"><span class="pre">download_from_cloud</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.download_from_cloud"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.download_from_cloud" title="Permalink to this definition"></a></dt>
    326. 

  326. <dd></dd></dl>
    327. 

  327. 

  328. <dl class="py method">
    329. 

  329. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.build_data_loaders">
    330. 

  330. <span class="sig-name descname"><span class="pre">build_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">test_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.build_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.build_data_loaders" title="Permalink to this definition"></a></dt>
    331. 

  331. <dd><p>define train, val (and optionally test) loaders. The method deals separately with distributed training and standard
    332. 

  332. (non distributed, or parallel training). In the case of distributed training we need to rely on distributed
    333. 

  333. samplers.
    334. 

  334. :param batch_size_factor: int - factor to multiply the batch size (usually for multi gpu)
    335. 

  335. :param num_workers: int - number of workers (parallel processes) for dataloaders
    336. 

  336. :param train_batch_size: int - batch size for train loader, if None will be taken from dataset_params
    337. 

  337. :param val_batch_size: int - batch size for val loader, if None will be taken from dataset_params
    338. 

  338. :param distributed_sampler: boolean flag for distributed training mode
    339. 

  339. :return: train_loader, val_loader, classes: list of classes</p>
    340. 

  340. </dd></dl>
    341. 

  341. 

  342. <dl class="py method">
    343. 

  343. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_data_loaders">
    344. 

  344. <span class="sig-name descname"><span class="pre">get_data_loaders</span></span><span class="sig-paren">(</span><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><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_data_loaders" title="Permalink to this definition"></a></dt>
    345. 

  345. <dd><p>Get self.train_loader, self.val_loader, self.test_loader, self.classes.</p>
    346. 

  346. <p>If the data loaders haven’t been initialized yet, build them first.</p>
    347. 

  347. <dl class="field-list simple">
    348. 

  348. <dt class="field-odd">Parameters</dt>
    349. 

  349. <dd class="field-odd"><p><strong>kwargs</strong> – kwargs are passed to build_data_loaders.</p>
    350. 

  350. </dd>
    351. 

  351. </dl>
    352. 

  352. </dd></dl>
    353. 

  353. 

  354. <dl class="py method">
    355. 

  355. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_val_sample">
    356. 

  356. <span class="sig-name descname"><span class="pre">get_val_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_samples</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_val_sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_val_sample" title="Permalink to this definition"></a></dt>
    357. 

  357. <dd></dd></dl>
    358. 

  358. 

  359. <dl class="py method">
    360. 

  360. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_dataset_params">
    361. 

  361. <span class="sig-name descname"><span class="pre">get_dataset_params</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.get_dataset_params"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.get_dataset_params" title="Permalink to this definition"></a></dt>
    362. 

  362. <dd></dd></dl>
    363. 

  363. 

  364. <dl class="py method">
    365. 

  365. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DatasetInterface.print_dataset_details">
    366. 

  366. <span class="sig-name descname"><span class="pre">print_dataset_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DatasetInterface.print_dataset_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DatasetInterface.print_dataset_details" title="Permalink to this definition"></a></dt>
    367. 

  367. <dd></dd></dl>
    368. 

  368. 

  369. </dd></dl>
    370. 

  370. 

  371. <dl class="py class">
    372. 

  372. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.TestDatasetInterface">
    373. 

  373. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">TestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trainset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.TestDatasetInterface" title="Permalink to this definition"></a></dt>
    374. 

  374. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    375. 

  375. <dl class="py method">
    376. 

  376. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.TestDatasetInterface.get_data_loaders">
    377. 

  377. <span class="sig-name descname"><span class="pre">get_data_loaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_workers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">val_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">distributed_sampler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestDatasetInterface.get_data_loaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.TestDatasetInterface.get_data_loaders" title="Permalink to this definition"></a></dt>
    378. 

  378. <dd><p>Get self.train_loader, self.val_loader, self.test_loader, self.classes.</p>
    379. 

  379. <p>If the data loaders haven’t been initialized yet, build them first.</p>
    380. 

  380. <dl class="field-list simple">
    381. 

  381. <dt class="field-odd">Parameters</dt>
    382. 

  382. <dd class="field-odd"><p><strong>kwargs</strong> – kwargs are passed to build_data_loaders.</p>
    383. 

  383. </dd>
    384. 

  384. </dl>
    385. 

  385. </dd></dl>
    386. 

  386. 

  387. </dd></dl>
    388. 

  388. 

  389. <dl class="py class">
    390. 

  390. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.LibraryDatasetInterface">
    391. 

  391. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">LibraryDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cifar10'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_cutout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#LibraryDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.LibraryDatasetInterface" title="Permalink to this definition"></a></dt>
    392. 

  392. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    393. 

  393. </dd></dl>
    394. 

  394. 

  395. <dl class="py class">
    396. 

  396. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.ClassificationDatasetInterface">
    397. 

  397. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">ClassificationDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">normalization_mean</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalization_std</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(1,</span> <span class="pre">1,</span> <span class="pre">1)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">64</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ClassificationDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.ClassificationDatasetInterface" title="Permalink to this definition"></a></dt>
    398. 

  398. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    399. 

  399. </dd></dl>
    400. 

  400. 

  401. <dl class="py class">
    402. 

  402. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.Cifar10DatasetInterface">
    403. 

  403. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">Cifar10DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#Cifar10DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.Cifar10DatasetInterface" title="Permalink to this definition"></a></dt>
    404. 

  404. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface</span></code></a></p>
    405. 

  405. </dd></dl>
    406. 

  406. 

  407. <dl class="py class">
    408. 

  408. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.Cifar100DatasetInterface">
    409. 

  409. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">Cifar100DatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#Cifar100DatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.Cifar100DatasetInterface" title="Permalink to this definition"></a></dt>
    410. 

  410. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.LibraryDatasetInterface</span></code></a></p>
    411. 

  411. </dd></dl>
    412. 

  412. 

  413. <dl class="py class">
    414. 

  414. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.ImageNetDatasetInterface">
    415. 

  415. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">ImageNetDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/data/Imagenet'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ImageNetDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.ImageNetDatasetInterface" title="Permalink to this definition"></a></dt>
    416. 

  416. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    417. 

  417. </dd></dl>
    418. 

  418. 

  419. <dl class="py class">
    420. 

  420. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.TinyImageNetDatasetInterface">
    421. 

  421. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">TinyImageNetDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/data/TinyImagenet'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TinyImageNetDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.TinyImageNetDatasetInterface" title="Permalink to this definition"></a></dt>
    422. 

  422. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    423. 

  423. </dd></dl>
    424. 

  424. 

  425. <dl class="py class">
    426. 

  426. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.CoCoSegmentationDatasetInterface">
    427. 

  427. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">CoCoSegmentationDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset_classes_inclusion_tuples_list</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CoCoSegmentationDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.CoCoSegmentationDatasetInterface" title="Permalink to this definition"></a></dt>
    428. 

  428. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.CoCoDataSetInterfaceBase</span></code></a></p>
    429. 

  429. </dd></dl>
    430. 

  430. 

  431. <dl class="py class">
    432. 

  432. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.PascalAUG2012SegmentationDataSetInterface">
    433. 

  433. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">PascalAUG2012SegmentationDataSetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalAUG2012SegmentationDataSetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.PascalAUG2012SegmentationDataSetInterface" title="Permalink to this definition"></a></dt>
    434. 

  434. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    435. 

  435. </dd></dl>
    436. 

  436. 

  437. <dl class="py class">
    438. 

  438. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.PascalVOC2012SegmentationDataSetInterface">
    439. 

  439. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">PascalVOC2012SegmentationDataSetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_images</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalVOC2012SegmentationDataSetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.PascalVOC2012SegmentationDataSetInterface" title="Permalink to this definition"></a></dt>
    440. 

  440. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    441. 

  441. </dd></dl>
    442. 

  442. 

  443. <dl class="py class">
    444. 

  444. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.TestYoloDetectionDatasetInterface">
    445. 

  445. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">TestYoloDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_dims</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">(3,</span> <span class="pre">32,</span> <span class="pre">32)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#TestYoloDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.TestYoloDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    446. 

  446. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DatasetInterface</span></code></a></p>
    447. 

  447. <p>note: the output size is (batch_size, 6) in the test while in real training
    448. 

  448. the size of axis 0 can vary (the number of bounding boxes)</p>
    449. 

  449. </dd></dl>
    450. 

  450. 

  451. <dl class="py class">
    452. 

  452. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.SegmentationTestDatasetInterface">
    453. 

  453. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">SegmentationTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">512</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#SegmentationTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.SegmentationTestDatasetInterface" title="Permalink to this definition"></a></dt>
    454. 

  454. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    455. 

  455. </dd></dl>
    456. 

  456. 

  457. <dl class="py class">
    458. 

  458. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.DetectionTestDatasetInterface">
    459. 

  459. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">DetectionTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">320</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#DetectionTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.DetectionTestDatasetInterface" title="Permalink to this definition"></a></dt>
    460. 

  460. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    461. 

  461. </dd></dl>
    462. 

  462. 

  463. <dl class="py class">
    464. 

  464. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.ClassificationTestDatasetInterface">
    465. 

  465. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">ClassificationTestDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#ClassificationTestDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.ClassificationTestDatasetInterface" title="Permalink to this definition"></a></dt>
    466. 

  466. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.TestDatasetInterface</span></code></a></p>
    467. 

  467. </dd></dl>
    468. 

  468. 

  469. <dl class="py class">
    470. 

  470. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.CoCoDetectionDatasetInterface">
    471. 

  471. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">CoCoDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</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/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#CoCoDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.CoCoDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    472. 

  472. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface</span></code></a></p>
    473. 

  473. </dd></dl>
    474. 

  474. 

  475. <dl class="py class">
    476. 

  476. <dt class="sig sig-object py" id="super_gradients.training.datasets.dataset_interfaces.PascalVOCUnifiedDetectionDatasetInterface">
    477. 

  477. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.training.datasets.dataset_interfaces.</span></span><span class="sig-name descname"><span class="pre">PascalVOCUnifiedDetectionDatasetInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/training/datasets/dataset_interfaces/dataset_interface.html#PascalVOCUnifiedDetectionDatasetInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.training.datasets.dataset_interfaces.PascalVOCUnifiedDetectionDatasetInterface" title="Permalink to this definition"></a></dt>
    478. 

  478. <dd><p>Bases: <a class="reference internal" href="#super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface" title="super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.training.datasets.dataset_interfaces.dataset_interface.DetectionDatasetInterface</span></code></a></p>
    479. 

  479. </dd></dl>
    480. 

  480. 

  481. </section>
    482. 

  482. </section>
    483. 

  483. 

  484. 

  485.            </div>
    486. 

  486.           </div>
    487. 

  487.           <footer>
    488. 

  488. 

  489.   <hr/>
    490. 

  490. 

  491.   <div role="contentinfo">
    492. 

  492.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    493. 

  493.   </div>
    494. 

  494. 

  495.   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    496. 

  496.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    497. 

  497.     provided by <a href="https://readthedocs.org">Read the Docs</a>.
    498. 

  498.    
    499. 

  499. 

  500. </footer>
    501. 

  501.         </div>
    502. 

  502.       </div>
    503. 

  503.     </section>
    504. 

  504.   </div>
    505. 

  505.   <script>
    506. 

  506.       jQuery(function () {
    507. 

  507.           SphinxRtdTheme.Navigation.enable(true);
    508. 

  508.       });
    509. 

  509.   </script> 
    510. 

  510. 

  511. </body>
    512. 

  512. </html>
    513.
Discard
Prev
Next
Tip!

Press p or to see the previous file or, n or to see the next file