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


  
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

	
            <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>super_gradients.training.datasets.sg_dataset &mdash; SuperGradients 1.0 documentation</title>
      <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="../../../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
        <script src="../../../../_static/jquery.js"></script>
        <script src="../../../../_static/underscore.js"></script>
        <script src="../../../../_static/doctools.js"></script>
    <script src="../../../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../search.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="../../../../index.html" class="icon icon-home"> SuperGradients
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption"><span class="caption-text">SuperGradients</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html">SuperGradients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.common.html">Common</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.training.html">Training</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../../index.html">SuperGradients</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="../../../index.html">Module code</a> &raquo;</li>
      <li>super_gradients.training.datasets.sg_dataset</li>
      <li class="wy-breadcrumbs-aside">
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <h1>Source code for super_gradients.training.datasets.sg_dataset</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">csv</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">os.path</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span>
<span class="kn">from</span> <span class="nn">torchvision.datasets</span> <span class="kn">import</span> <span class="n">VisionDataset</span>
<span class="kn">from</span> <span class="nn">torchvision.datasets.folder</span> <span class="kn">import</span> <span class="n">default_loader</span>

<span class="n">IMG_EXTENSIONS</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;.jpg&#39;</span><span class="p">,</span> <span class="s1">&#39;.jpeg&#39;</span><span class="p">,</span> <span class="s1">&#39;.png&#39;</span><span class="p">,</span> <span class="s1">&#39;.ppm&#39;</span><span class="p">,</span> <span class="s1">&#39;.bmp&#39;</span><span class="p">,</span> <span class="s1">&#39;.pgm&#39;</span><span class="p">,</span> <span class="s1">&#39;.tif&#39;</span><span class="p">,</span> <span class="s1">&#39;.tiff&#39;</span><span class="p">,</span> <span class="s1">&#39;.webp&#39;</span><span class="p">)</span>


<div class="viewcode-block" id="BaseSgVisionDataset"><a class="viewcode-back" href="../../../../super_gradients.training.datasets.html#super_gradients.training.datasets.sg_dataset.BaseSgVisionDataset">[docs]</a><span class="k">class</span> <span class="nc">BaseSgVisionDataset</span><span class="p">(</span><span class="n">VisionDataset</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    BaseSgVisionDataset</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">root</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sample_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">default_loader</span><span class="p">,</span> <span class="n">target_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                 <span class="n">collate_fn</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">valid_sample_extensions</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">=</span> <span class="n">IMG_EXTENSIONS</span><span class="p">,</span>
                 <span class="n">sample_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">target_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Ctor</span>
<span class="sd">            :param root:</span>
<span class="sd">            :param sample_loader:</span>
<span class="sd">            :param target_loader:</span>
<span class="sd">            :param collate_fn:</span>
<span class="sd">            :param valid_sample_extensions:</span>
<span class="sd">            :param sample_transform:</span>
<span class="sd">            :param target_transform:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">root</span><span class="o">=</span><span class="n">root</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">sample_transform</span><span class="p">,</span> <span class="n">target_transform</span><span class="o">=</span><span class="n">target_transform</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">tuple</span><span class="p">())</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">classes</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">valid_sample_extensions</span> <span class="o">=</span> <span class="n">valid_sample_extensions</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">sample_loader</span> <span class="o">=</span> <span class="n">sample_loader</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">target_loader</span> <span class="o">=</span> <span class="n">target_loader</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_generate_samples_and_targets</span><span class="p">()</span>

        <span class="c1"># IF collate_fn IS PROVIDED IN CTOR WE ASSUME THERE IS A BASE-CLASS INHERITANCE W/O collate_fn IMPLEMENTATION</span>
        <span class="k">if</span> <span class="n">collate_fn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">collate_fn</span> <span class="o">=</span> <span class="n">collate_fn</span>

    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>

<span class="sd">        :param item:</span>
<span class="sd">        :return:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span>

    <span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>

<span class="sd">        :return:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">_generate_samples_and_targets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        _generate_samples_and_targets - An abstract method that fills the samples and targets members of the class</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span>

    <span class="k">def</span> <span class="nf">_validate_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        validate_file</span>
<span class="sd">            :param filename:</span>
<span class="sd">            :return:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">for</span> <span class="n">valid_extension</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">valid_sample_extensions</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">valid_extension</span><span class="p">):</span>
                <span class="k">return</span> <span class="kc">True</span>

        <span class="k">return</span> <span class="kc">False</span>

<div class="viewcode-block" id="BaseSgVisionDataset.numpy_loader_func"><a class="viewcode-back" href="../../../../super_gradients.training.datasets.html#super_gradients.training.datasets.sg_dataset.BaseSgVisionDataset.numpy_loader_func">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">numpy_loader_func</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        _numpy_loader_func - Uses numpy load func</span>
<span class="sd">            :param path:</span>
<span class="sd">            :return:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div>

<div class="viewcode-block" id="BaseSgVisionDataset.text_file_loader_func"><a class="viewcode-back" href="../../../../super_gradients.training.datasets.html#super_gradients.training.datasets.sg_dataset.BaseSgVisionDataset.text_file_loader_func">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">text_file_loader_func</span><span class="p">(</span><span class="n">text_file_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">inline_splitter</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        text_file_loader_func - Uses a line by line based code to get vectorized data from a text-based file</span>
<span class="sd">            :param text_file_path:  Input text file</span>
<span class="sd">            :param inline_splitter: The char to use in order to separate between different VALUES of the SAME vector</span>
<span class="sd">                                    please notice that DIFFERENT VECTORS SHOULD BE IN SEPARATE LINES (&#39;\n&#39;) SEPARATED</span>
<span class="sd">            :return: a list of tuples, where each tuple is a vector of target values</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">text_file_path</span><span class="p">):</span>
            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot; Error in text file path&quot;</span><span class="p">)</span>

        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">text_file_path</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">text_file</span><span class="p">:</span>
            <span class="n">targets_list</span> <span class="o">=</span> <span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">inline_splitter</span><span class="p">)))</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">text_file</span><span class="p">]</span>

        <span class="k">return</span> <span class="n">targets_list</span></div></div>


<div class="viewcode-block" id="DirectoryDataSet"><a class="viewcode-back" href="../../../../super_gradients.training.datasets.html#super_gradients.training.datasets.sg_dataset.DirectoryDataSet">[docs]</a><span class="k">class</span> <span class="nc">DirectoryDataSet</span><span class="p">(</span><span class="n">BaseSgVisionDataset</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    DirectoryDataSet - A PyTorch Vision Data Set extension that receives a root Dir and two separate sub directories:</span>
<span class="sd">                        - Sub-Directory for Samples</span>
<span class="sd">                        - Sub-Directory for Targets</span>

<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">root</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
                 <span class="n">samples_sub_directory</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">targets_sub_directory</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">target_extension</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
                 <span class="n">sample_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">default_loader</span><span class="p">,</span> <span class="n">target_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">collate_fn</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                 <span class="n">sample_extensions</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">=</span> <span class="n">IMG_EXTENSIONS</span><span class="p">,</span> <span class="n">sample_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                 <span class="n">target_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        CTOR</span>
<span class="sd">            :param root:                    root directory that contains all of the Data Set</span>
<span class="sd">            :param samples_sub_directory:   name of the samples sub-directory</span>
<span class="sd">            :param targets_sub_directory:   name of the targets sub-directory</span>
<span class="sd">            :param sample_extensions:       file extensions for samples</span>
<span class="sd">            :param target_extension:        file extension of the targets</span>
<span class="sd">            :param sample_loader:           Func to load samples</span>
<span class="sd">            :param target_loader:           Func to load targets</span>
<span class="sd">            :param collate_fn:              collate_fn func to process batches for the Data Loader</span>
<span class="sd">            :param sample_transform:        Func to pre-process samples for data loading</span>
<span class="sd">            :param target_transform:        Func to pre-process targets for data loading</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="c1"># INITIALIZING THE TARGETS LOADER TO USE THE TEXT FILE LOADER FUNC</span>
        <span class="k">if</span> <span class="n">target_loader</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">target_loader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">text_file_loader_func</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">target_extension</span> <span class="o">=</span> <span class="n">target_extension</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">samples_dir_suffix</span> <span class="o">=</span> <span class="n">samples_sub_directory</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">targets_dir_suffix</span> <span class="o">=</span> <span class="n">targets_sub_directory</span>

        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">root</span><span class="o">=</span><span class="n">root</span><span class="p">,</span> <span class="n">sample_loader</span><span class="o">=</span><span class="n">sample_loader</span><span class="p">,</span> <span class="n">target_loader</span><span class="o">=</span><span class="n">target_loader</span><span class="p">,</span>
                         <span class="n">collate_fn</span><span class="o">=</span><span class="n">collate_fn</span><span class="p">,</span> <span class="n">valid_sample_extensions</span><span class="o">=</span><span class="n">sample_extensions</span><span class="p">,</span>
                         <span class="n">sample_transform</span><span class="o">=</span><span class="n">sample_transform</span><span class="p">,</span> <span class="n">target_transform</span><span class="o">=</span><span class="n">target_transform</span><span class="p">)</span>

    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        getter method for iteration</span>
<span class="sd">            :param item:</span>
<span class="sd">            :return:</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">sample_path</span><span class="p">,</span> <span class="n">target_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span><span class="p">[</span><span class="n">item</span><span class="p">]</span>
        <span class="n">sample</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sample_loader</span><span class="p">(</span><span class="n">sample_path</span><span class="p">)</span>
        <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_loader</span><span class="p">(</span><span class="n">target_path</span><span class="p">)</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">sample</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">sample</span><span class="p">)</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_transform</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_transform</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>

        <span class="k">return</span> <span class="n">sample</span><span class="p">,</span> <span class="n">target</span>

    <span class="k">def</span> <span class="nf">_generate_samples_and_targets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        _generate_samples_and_targets - Uses class built in members to generate the list of (SAMPLE, TARGET/S)</span>
<span class="sd">                                        that is saved in self.samples_targets_tuples_list</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">missing_sample_files</span><span class="p">,</span> <span class="n">missing_target_files</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span>

        <span class="c1"># VALIDATE DATA PATH</span>
        <span class="n">samples_dir_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">samples_dir_suffix</span>
        <span class="n">targets_dir_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">targets_dir_suffix</span>

        <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">samples_dir_path</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">targets_dir_path</span><span class="p">):</span>
            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot; Error in data path&quot;</span><span class="p">)</span>

        <span class="c1"># ITERATE OVER SAMPLES AND MAKE SURE THERE ARE MATCHING LABELS</span>
        <span class="k">for</span> <span class="n">sample_file_name</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">samples_dir_path</span><span class="p">):</span>
            <span class="n">sample_file_path</span> <span class="o">=</span> <span class="n">samples_dir_path</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="n">sample_file_name</span>
            <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">sample_file_path</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_file</span><span class="p">(</span><span class="n">sample_file_path</span><span class="p">):</span>
                <span class="n">sample_file_prefix</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">sample_file_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[:</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>

                <span class="c1"># TRY TO GET THE MATCHING LABEL</span>
                <span class="n">matching_target_file_name</span> <span class="o">=</span> <span class="n">sample_file_prefix</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_extension</span>
                <span class="n">target_file_path</span> <span class="o">=</span> <span class="n">targets_dir_path</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="n">matching_target_file_name</span>
                <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">target_file_path</span><span class="p">):</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">sample_file_path</span><span class="p">,</span> <span class="n">target_file_path</span><span class="p">))</span>

                <span class="k">else</span><span class="p">:</span>
                    <span class="n">missing_target_files</span> <span class="o">+=</span> <span class="mi">1</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">missing_sample_files</span> <span class="o">+=</span> <span class="mi">1</span>

        <span class="k">for</span> <span class="n">counter_name</span><span class="p">,</span> <span class="n">missing_files_counter</span> <span class="ow">in</span> <span class="p">[(</span><span class="s1">&#39;samples&#39;</span><span class="p">,</span> <span class="n">missing_sample_files</span><span class="p">),</span>
                                                    <span class="p">(</span><span class="s1">&#39;targets&#39;</span><span class="p">,</span> <span class="n">missing_target_files</span><span class="p">)]:</span>
            <span class="k">if</span> <span class="n">missing_files_counter</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
                <span class="nb">print</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; There are &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">missing_files_counter</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; missing  &#39;</span> <span class="o">+</span> <span class="n">counter_name</span><span class="p">)</span></div>


<div class="viewcode-block" id="ListDataset"><a class="viewcode-back" href="../../../../super_gradients.training.datasets.html#super_gradients.training.datasets.sg_dataset.ListDataset">[docs]</a><span class="k">class</span> <span class="nc">ListDataset</span><span class="p">(</span><span class="n">BaseSgVisionDataset</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    ListDataset - A PyTorch Vision Data Set extension that receives a file with FULL PATH to each of the samples.</span>
<span class="sd">                  Then, the assumption is that for every sample, there is a * matching target * in the same</span>
<span class="sd">                  path but with a different extension, i.e:</span>
<span class="sd">                        for the samples paths:  (That appear in the list file)</span>
<span class="sd">                                                    /root/dataset/class_x/sample1.png</span>
<span class="sd">                                                    /root/dataset/class_y/sample123.png</span>

<span class="sd">                        the matching labels paths:  (That DO NOT appear in the list file)</span>
<span class="sd">                                                    /root/dataset/class_x/sample1.ext</span>
<span class="sd">                                                    /root/dataset/class_y/sample123.ext</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">root</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">sample_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">default_loader</span><span class="p">,</span> <span class="n">target_loader</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
                 <span class="n">collate_fn</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">sample_extensions</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">=</span> <span class="n">IMG_EXTENSIONS</span><span class="p">,</span>
                 <span class="n">sample_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">target_transform</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">target_extension</span><span class="o">=</span><span class="s1">&#39;.npy&#39;</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">           CTOR</span>
<span class="sd">               :param root:                    root directory that contains all of the Data Set</span>
<span class="sd">               :param file:                    Path to the file with the samples list</span>
<span class="sd">               :param sample_extensions:       file extension for samples</span>
<span class="sd">               :param target_extension:        file extension of the targets</span>
<span class="sd">               :param sample_loader:           Func to load samples</span>
<span class="sd">               :param target_loader:           Func to load targets</span>
<span class="sd">               :param collate_fn:              collate_fn func to process batches for the Data Loader</span>
<span class="sd">               :param sample_transform:        Func to pre-process samples for data loading</span>
<span class="sd">               :param target_transform:        Func to pre-process targets for data loading</span>
<span class="sd">           &quot;&quot;&quot;</span>

        <span class="k">if</span> <span class="n">target_loader</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">target_loader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">numpy_loader_func</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">list_file_path</span> <span class="o">=</span> <span class="n">file</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">loader</span> <span class="o">=</span> <span class="n">sample_loader</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">target_loader</span> <span class="o">=</span> <span class="n">target_loader</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">extensions</span> <span class="o">=</span> <span class="n">sample_extensions</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">target_extension</span> <span class="o">=</span> <span class="n">target_extension</span>

        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">sample_loader</span><span class="o">=</span><span class="n">sample_loader</span><span class="p">,</span> <span class="n">target_loader</span><span class="o">=</span><span class="n">target_loader</span><span class="p">,</span>
                         <span class="n">collate_fn</span><span class="o">=</span><span class="n">collate_fn</span><span class="p">,</span> <span class="n">sample_transform</span><span class="o">=</span><span class="n">sample_transform</span><span class="p">,</span>
                         <span class="n">valid_sample_extensions</span><span class="o">=</span><span class="n">sample_extensions</span><span class="p">,</span>
                         <span class="n">target_transform</span><span class="o">=</span><span class="n">target_transform</span><span class="p">)</span>

    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Args:</span>
<span class="sd">            item (int): Index</span>
<span class="sd">        Returns:</span>
<span class="sd">            tuple: (sample, target) where target is class_index of the target class.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">sample_path</span><span class="p">,</span> <span class="n">target_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span><span class="p">[</span><span class="n">item</span><span class="p">]</span>
        <span class="n">sample</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">loader</span><span class="p">(</span><span class="n">sample_path</span><span class="p">)</span>
        <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_loader</span><span class="p">(</span><span class="n">target_path</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">sample</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="n">sample</span><span class="p">)</span>
        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_transform</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_transform</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>

        <span class="k">return</span> <span class="n">sample</span><span class="p">,</span> <span class="n">target</span>

    <span class="k">def</span> <span class="nf">_generate_samples_and_targets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        _generate_samples_and_targets</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_file_path</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>

        <span class="n">reader</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">file</span><span class="p">)</span>
        <span class="n">data</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">reader</span><span class="p">]</span>

        <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
            <span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span> <span class="o">+</span> <span class="n">f</span>
            <span class="n">target_path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[:</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">target_extension</span>
            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_validate_file</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">target_path</span><span class="p">):</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">samples_targets_tuples_list</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">path</span><span class="p">,</span> <span class="n">target_path</span><span class="p">))</span></div>
</pre></div>

           </div>
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2021, SuperGradients team.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>