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

welcome.html 51 KB
History Raw

You have to be logged in to leave a comment. Sign In
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698 
  1. <!DOCTYPE html>
    2. 

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

  3. <head>
    4. 

  4.   <meta charset="utf-8" />
    5. 

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

  6.   <title>Version 3 is out! Notebooks have been updated! &mdash; SuperGradients 3.0.3 documentation</title>
    7. 

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

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

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

  10.       <link rel="stylesheet" href="_static/custom.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/_sphinx_javascript_frameworks_compat.js"></script>
    19. 

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

  20.         <script src="_static/sphinx_highlight.js"></script>
    21. 

  21.     <script src="_static/js/theme.js"></script>
    22. 

  22.     <link rel="index" title="Index" href="genindex.html" />
    23. 

  23.     <link rel="search" title="Search" href="search.html" />
    24. 

  24.     <link rel="next" title="Common package" href="super_gradients.common.html" />
    25. 

  25.     <link rel="prev" title="Welcome to SuperGradients’s documentation!" href="index.html" /> 
    26. 

  26. </head>
    27. 

  27. 

  28. <body class="wy-body-for-nav"> 
    29. 

  29.   <div class="wy-grid-for-nav">
    30. 

  30.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    31. 

  31.       <div class="wy-side-scroll">
    32. 

  32.         <div class="wy-side-nav-search" >
    33. 

  33.             <a href="index.html" class="icon icon-home"> SuperGradients
    34. 

  34.           </a>
    35. 

  35. <div role="search">
    36. 

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

  37.     <input type="text" name="q" placeholder="Search docs" />
    38. 

  38.     <input type="hidden" name="check_keywords" value="yes" />
    39. 

  39.     <input type="hidden" name="area" value="default" />
    40. 

  40.   </form>
    41. 

  41. </div>
    42. 

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

  43.               <p class="caption" role="heading"><span class="caption-text">Welcome To SuperGradients</span></p>
    44. 

  44. <ul class="current">
    45. 

  45. <li class="toctree-l1 current"><a class="current reference internal" href="#">Version 3 is out! Notebooks have been updated!</a></li>
    46. 

  46. <li class="toctree-l1"><a class="reference internal" href="#build-with-supergradients">Build with SuperGradients</a><ul>
    47. 

  47. <li class="toctree-l2"><a class="reference internal" href="#support-various-computer-vision-tasks">Support various computer vision tasks</a></li>
    48. 

  48. <li class="toctree-l2"><a class="reference internal" href="#ready-to-deploy-pre-trained-sota-models">Ready to deploy pre-trained SOTA models</a><ul>
    49. 

  49. <li class="toctree-l3"><a class="reference internal" href="#classification">Classification</a></li>
    50. 

  50. <li class="toctree-l3"><a class="reference internal" href="#semantic-segmentation">Semantic Segmentation</a></li>
    51. 

  51. <li class="toctree-l3"><a class="reference internal" href="#object-detection">Object Detection</a></li>
    52. 

  52. </ul>
    53. 

  53. </li>
    54. 

  54. <li class="toctree-l2"><a class="reference internal" href="#easy-to-train-sota-models">Easy to train SOTA Models</a></li>
    55. 

  55. <li class="toctree-l2"><a class="reference internal" href="#plug-and-play-recipes">Plug and play recipes</a></li>
    56. 

  56. <li class="toctree-l2"><a class="reference internal" href="#production-readiness">Production readiness</a></li>
    57. 

  57. </ul>
    58. 

  58. </li>
    59. 

  59. <li class="toctree-l1"><a class="reference internal" href="#quick-installation">Quick Installation</a></li>
    60. 

  60. <li class="toctree-l1"><a class="reference internal" href="#what-s-new">What’s New</a></li>
    61. 

  61. <li class="toctree-l1"><a class="reference internal" href="#coming-soon">Coming soon</a></li>
    62. 

  62. <li class="toctree-l1"><a class="reference internal" href="#table-of-content">Table of Content</a></li>
    63. 

  63. <li class="toctree-l1"><a class="reference internal" href="#getting-started">Getting Started</a><ul>
    64. 

  64. <li class="toctree-l2"><a class="reference internal" href="#start-training-with-just-1-command-line">Start Training with Just 1 Command Line</a></li>
    65. 

  65. <li class="toctree-l2"><a class="reference internal" href="#quickly-load-pre-trained-weights-for-your-desired-model-with-sota-performance">Quickly Load Pre-Trained Weights for Your Desired Model with SOTA Performance</a></li>
    66. 

  66. <li class="toctree-l2"><a class="reference internal" href="#id1">Classification</a><ul>
    67. 

  67. <li class="toctree-l3"><a class="reference internal" href="#transfer-learning">Transfer Learning</a></li>
    68. 

  68. </ul>
    69. 

  69. </li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="#id2">Semantic Segmentation</a><ul>
    71. 

  71. <li class="toctree-l3"><a class="reference internal" href="#quick-start">Quick Start</a></li>
    72. 

  72. <li class="toctree-l3"><a class="reference internal" href="#id3">Transfer Learning</a></li>
    73. 

  73. <li class="toctree-l3"><a class="reference internal" href="#how-to-connect-custom-dataset">How to Connect Custom Dataset</a></li>
    74. 

  74. </ul>
    75. 

  75. </li>
    76. 

  76. <li class="toctree-l2"><a class="reference internal" href="#id4">Object Detection</a><ul>
    77. 

  77. <li class="toctree-l3"><a class="reference internal" href="#id5">Transfer Learning</a></li>
    78. 

  78. <li class="toctree-l3"><a class="reference internal" href="#id6">How to Connect Custom Dataset</a></li>
    79. 

  79. </ul>
    80. 

  80. </li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="#how-to-predict-using-pre-trained-model">How to Predict Using Pre-trained Model</a><ul>
    82. 

  82. <li class="toctree-l3"><a class="reference internal" href="#segmentation-detection-and-classification-prediction">Segmentation, Detection and Classification Prediction</a></li>
    83. 

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. </li>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="#advanced-features">Advanced Features</a><ul>
    88. 

  88. <li class="toctree-l2"><a class="reference internal" href="#knowledge-distillation-training">Knowledge Distillation Training</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="#recipes">Recipes</a></li>
    90. 

  90. <li class="toctree-l2"><a class="reference internal" href="#using-ddp">Using DDP</a></li>
    91. 

  91. <li class="toctree-l2"><a class="reference internal" href="#easily-change-architectures-parameters">Easily change architectures parameters</a></li>
    92. 

  92. <li class="toctree-l2"><a class="reference internal" href="#using-phase-callbacks">Using phase callbacks</a></li>
    93. 

  93. <li class="toctree-l2"><a class="reference internal" href="#integration-to-weights-and-biases">Integration to Weights and Biases</a></li>
    94. 

  94. </ul>
    95. 

  95. </li>
    96. 

  96. <li class="toctree-l1"><a class="reference internal" href="#installation-methods">Installation Methods</a><ul>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="#id7">Quick Installation</a></li>
    99. 

  99. </ul>
    100. 

  100. </li>
    101. 

  101. <li class="toctree-l1"><a class="reference internal" href="#implemented-model-architectures">Implemented Model Architectures</a><ul>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="#image-classification">Image Classification</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="#id8">Semantic Segmentation</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="#id9">Object Detection</a></li>
    105. 

  105. </ul>
    106. 

  106. </li>
    107. 

  107. <li class="toctree-l1"><a class="reference internal" href="#documentation">Documentation</a></li>
    108. 

  108. <li class="toctree-l1"><a class="reference internal" href="#contributing">Contributing</a></li>
    109. 

  109. <li class="toctree-l1"><a class="reference internal" href="#citation">Citation</a></li>
    110. 

  110. <li class="toctree-l1"><a class="reference internal" href="#community">Community</a></li>
    111. 

  111. <li class="toctree-l1"><a class="reference internal" href="#license">License</a></li>
    112. 

  112. <li class="toctree-l1"><a class="reference internal" href="#deci-platform">Deci Platform</a></li>
    113. 

  113. </ul>
    114. 

  114. <p class="caption" role="heading"><span class="caption-text">Technical Documentation</span></p>
    115. 

  115. <ul>
    116. 

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

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

  118. </ul>
    119. 

  119. 

  120.         </div>
    121. 

  121.       </div>
    122. 

  122.     </nav>
    123. 

  123. 

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

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

  126.           <a href="index.html">SuperGradients</a>
    127. 

  127.       </nav>
    128. 

  128. 

  129.       <div class="wy-nav-content">
    130. 

  130.         <div class="rst-content">
    131. 

  131.           <div role="navigation" aria-label="Page navigation">
    132. 

  132.   <ul class="wy-breadcrumbs">
    133. 

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

  134.       <li>Version 3 is out! Notebooks have been updated!</li>
    135. 

  135.       <li class="wy-breadcrumbs-aside">
    136. 

  136.             <a href="_sources/welcome.md.txt" rel="nofollow"> View page source</a>
    137. 

  137.       </li>
    138. 

  138.   </ul>
    139. 

  139.   <hr/>
    140. 

  140. </div>
    141. 

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

  142.            <div itemprop="articleBody">
    143. 

  143.              
    144. 

  144.   <div align="center">
    145. 

  145.   <img src="assets/SG_img/SG - Horizontal Glow 2.png" width="600"/>
    146. 

  146.  <br/><br/>
    147. 

  147. <p><strong>Build, train, and fine-tune production-ready deep learning  SOTA vision models</strong>
    148. 

  148. <a class="reference external" href="https://twitter.com/intent/tweet?text=Easily%20train%20or%20fine-tune%20SOTA%20computer%20vision%20models%20from%20one%20training%20repository&amp;url=https://github.com/Deci-AI/super-gradients&amp;via=deci_ai&amp;hashtags=AI,deeplearning,computervision,training,opensource"><img alt="Tweet" src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social" /></a></p>
    149. 

  149. <div class="section" id="version-3-is-out-notebooks-have-been-updated">
    150. 

  150. <h1>Version 3 is out! Notebooks have been updated!<a class="headerlink" href="#version-3-is-out-notebooks-have-been-updated" title="Permalink to this heading"></a></h1>
    151. 

  151. <hr class="docutils" />
    152. 

  152.   <p align="center">
    153. 

  153.   <a href="https://www.supergradients.com/">Website</a> •
    154. 

  154.   <a href="https://deci-ai.github.io/super-gradients/user_guide.html#introducing-the-supergradients-library">User Guide</a> •
    155. 

  155.   <a href="https://deci-ai.github.io/super-gradients/super_gradients.common.html">Docs</a> •
    156. 

  156.   <a href="#getting-started">Getting Started</a> •
    157. 

  157.   <a href="#implemented-model-architectures">Pretrained Models</a> •
    158. 

  158.   <a href="#community">Community</a> •
    159. 

  159.   <a href="#license">License</a> •
    160. 

  160.   <a href="#deci-platform">Deci Platform</a>
    161. 

  161. </p>
    162. 

  162. <p align="center">
    163. 

  163.   <a href="https://github.com/Deci-AI/super-gradients#prerequisites"><img src="https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue" />
    164. 

  164.   <a href="https://github.com/Deci-AI/super-gradients#prerequisites"><img src="https://img.shields.io/badge/pytorch-1.9%20%7C%201.10-blue" />
    165. 

  165.   <a href="https://pypi.org/project/super-gradients/"><img src="https://img.shields.io/pypi/v/super-gradients" />
    166. 

  166.   <a href="https://github.com/Deci-AI/super-gradients#computer-vision-models-pretrained-checkpoints" ><img src="https://img.shields.io/badge/pre--trained%20models-34-brightgreen" />
    167. 

  167.   <a href="https://github.com/Deci-AI/super-gradients/releases"><img src="https://img.shields.io/github/v/release/Deci-AI/super-gradients" />
    168. 

  168.   <a href="https://join.slack.com/t/supergradients-comm52/shared_invite/zt-10vz6o1ia-b_0W5jEPEnuHXm087K~t8Q"><img src="https://img.shields.io/badge/slack-community-blueviolet" />
    169. 

  169.   <a href="https://github.com/Deci-AI/super-gradients/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" />
    170. 

  170.   <a href="https://deci-ai.github.io/super-gradients/welcome.html"><img src="https://img.shields.io/badge/docs-sphinx-brightgreen" />
    171. 

  171. </p>    
    172. 

  172. </div>
    173. 

  173. <p><a class="reference external" href="https://deci-ai.github.io/super-gradients/user_guide.html#introducing-the-supergradients-library"></a></p>
    174. 

  174. </div>
    175. 

  175. <div class="section" id="build-with-supergradients">
    176. 

  176. <h1>Build with SuperGradients<a class="headerlink" href="#build-with-supergradients" title="Permalink to this heading"></a></h1>
    177. 

  177. <hr class="docutils" />
    178. 

  178. <div class="section" id="support-various-computer-vision-tasks">
    179. 

  179. <h2>Support various computer vision tasks<a class="headerlink" href="#support-various-computer-vision-tasks" title="Permalink to this heading"></a></h2>
    180. 

  180. <div align="center">
    181. 

  181. <img src="./assets/SG_img/Segmentation 1500x900 .png" width="250px">
    182. 

  182. <img src="./assets/SG_img/Object detection 1500X900.png" width="250px">
    183. 

  183. <img src="./assets/SG_img/Classification 1500x900.png" width="250px">
    184. 

  184. </div>
    185. 

  185. </div>
    186. 

  186. <div class="section" id="ready-to-deploy-pre-trained-sota-models">
    187. 

  187. <h2>Ready to deploy pre-trained SOTA models<a class="headerlink" href="#ready-to-deploy-pre-trained-sota-models" title="Permalink to this heading"></a></h2>
    188. 

  188. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Load model with pretrained weights</span>
    189. 

  189. <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;yolox_s&quot;</span><span class="p">,</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;coco&quot;</span><span class="p">)</span>
    190. 

  190. </pre></div>
    191. 

  191. </div>
    192. 

  192. <div class="section" id="classification">
    193. 

  193. <h3>Classification<a class="headerlink" href="#classification" title="Permalink to this heading"></a></h3>
    194. 

  194. <div align="center">
    195. 

  195. <img src="./assets/SG_img/Classification@2xDark.png" width="800px">
    196. 

  196. </div>
    197. 

  197. </div>
    198. 

  198. <div class="section" id="semantic-segmentation">
    199. 

  199. <h3>Semantic Segmentation<a class="headerlink" href="#semantic-segmentation" title="Permalink to this heading"></a></h3>
    200. 

  200. <div align="center">
    201. 

  201. <img src="./assets/SG_img/Semantic Segmentation@2xDark.png" width="800px">
    202. 

  202. </div>
    203. 

  203. </div>
    204. 

  204. <div class="section" id="object-detection">
    205. 

  205. <h3>Object Detection<a class="headerlink" href="#object-detection" title="Permalink to this heading"></a></h3>
    206. 

  206. <div align="center">
    207. 

  207. <img src="./assets/SG_img/Object Detection@2xDark.png" width="800px">
    208. 

  208. </div>
    209. 

  209. <p>All Computer Vision Models - Pretrained Checkpoints can be found <span class="xref myst">here</span></p>
    210. 

  210. </div>
    211. 

  211. </div>
    212. 

  212. <div class="section" id="easy-to-train-sota-models">
    213. 

  213. <h2>Easy to train SOTA Models<a class="headerlink" href="#easy-to-train-sota-models" title="Permalink to this heading"></a></h2>
    214. 

  214. <p>Easily load and fine-tune production-ready, pre-trained SOTA models that incorporate best practices and validated hyper-parameters for achieving best-in-class accuracy.
    215. 

  215. For more information on how to do it go to <span class="xref myst">Getting Started</span></p>
    216. 

  216. </div>
    217. 

  217. <div class="section" id="plug-and-play-recipes">
    218. 

  218. <h2>Plug and play recipes<a class="headerlink" href="#plug-and-play-recipes" title="Permalink to this heading"></a></h2>
    219. 

  219. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">super_gradients</span><span class="o">.</span><span class="n">train_from_recipe</span> <span class="o">--</span><span class="n">config</span><span class="o">-</span><span class="n">name</span><span class="o">=</span><span class="n">imagenet_regnetY</span> <span class="n">architecture</span><span class="o">=</span><span class="n">regnetY800</span> <span class="n">dataset_interface</span><span class="o">.</span><span class="n">data_dir</span><span class="o">=&lt;</span><span class="n">YOUR_Imagenet_LOCAL_PATH</span><span class="o">&gt;</span> <span class="n">ckpt_root_dir</span><span class="o">=&lt;</span><span class="n">CHEKPOINT_DIRECTORY</span><span class="o">&gt;</span>
    220. 

  220. </pre></div>
    221. 

  221. </div>
    222. 

  222. <p>More example on how and why to use recipes can be found in <span class="xref myst">Recipes</span></p>
    223. 

  223. </div>
    224. 

  224. <div class="section" id="production-readiness">
    225. 

  225. <h2>Production readiness<a class="headerlink" href="#production-readiness" title="Permalink to this heading"></a></h2>
    226. 

  226. <p>All SuperGradients models’ are production ready in the sense that they are compatible with deployment tools such as TensorRT (Nvidia) and OpenVINO (Intel) and can be easily taken into production. With a few lines of code you can easily integrate the models into your codebase.</p>
    227. 

  227. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Load model with pretrained weights</span>
    228. 

  228. <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;yolox_s&quot;</span><span class="p">,</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;coco&quot;</span><span class="p">)</span>
    229. 

  229. 

  230. <span class="c1"># Prepare model for conversion</span>
    231. 

  231. <span class="c1"># Input size is in format of [Batch x Channels x Width x Height] where 640 is the standart COCO dataset dimensions</span>
    232. 

  232. <span class="n">model</span><span class="o">.</span><span class="n">eval</span><span class="p">()</span>
    233. 

  233. <span class="n">model</span><span class="o">.</span><span class="n">prep_model_for_conversion</span><span class="p">(</span><span class="n">input_size</span><span class="o">=</span><span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">640</span><span class="p">,</span> <span class="mi">640</span><span class="p">])</span>
    234. 

  234.     
    235. 

  235. <span class="c1"># Create dummy_input</span>
    236. 

  236. 

  237. <span class="c1"># Convert model to onnx</span>
    238. 

  238. <span class="n">torch</span><span class="o">.</span><span class="n">onnx</span><span class="o">.</span><span class="n">export</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">dummy_input</span><span class="p">,</span>  <span class="s2">&quot;yolox_s.onnx&quot;</span><span class="p">)</span>
    239. 

  239. </pre></div>
    240. 

  240. </div>
    241. 

  241. <p>More information on how to take your model to production can be found in <span class="xref myst">Getting Started</span> notebooks</p>
    242. 

  242. </div>
    243. 

  243. </div>
    244. 

  244. <div class="section" id="quick-installation">
    245. 

  245. <h1>Quick Installation<a class="headerlink" href="#quick-installation" title="Permalink to this heading"></a></h1>
    246. 

  246. <hr class="docutils" />
    247. 

  247. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install super-gradients
    248. 

  248. </pre></div>
    249. 

  249. </div>
    250. 

  250. </div>
    251. 

  251. <div class="section" id="what-s-new">
    252. 

  252. <h1>What’s New<a class="headerlink" href="#what-s-new" title="Permalink to this heading"></a></h1>
    253. 

  253. <hr class="docutils" />
    254. 

  254. <ul class="simple">
    255. 

  255. <li><p>【06/9/2022】 PP-LiteSeg - new pre-trained <span class="xref myst">checkpoints</span>  for Cityscapes with SOTA mIoU scores (~1.5% above paper)🎯</p></li>
    256. 

  256. <li><p>【07/08/2022】DDRNet23 -  new pre-trained <span class="xref myst">checkpoints</span> and <a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/recipes">recipes</a> for Cityscapes with SOTA mIoU scores (~1% above paper)🎯</p></li>
    257. 

  257. <li><p>【27/07/2022】YOLOX models (object detection) - recipes and pre-trained checkpoints.</p></li>
    258. 

  258. <li><p>【07/07/2022】SSD Lite MobileNet V2,V1 - Training <a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/recipes/coco_ssd_lite_mobilenet_v2.yaml">recipes</a> and pre-trained <span class="xref myst">checkpoints</span> on COCO - Tailored for edge devices! 📱</p></li>
    259. 

  259. <li><p>【07/07/2022】 STDC  - new pre-trained <span class="xref myst">checkpoints</span> and <a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/recipes">recipes</a> for Cityscapes with super SOTA mIoU scores (~2.5% above paper)🎯</p></li>
    260. 

  260. </ul>
    261. 

  261. <p>Check out SG full <a class="reference external" href="https://github.com/Deci-AI/super-gradients/releases">release notes</a>.</p>
    262. 

  262. </div>
    263. 

  263. <div class="section" id="coming-soon">
    264. 

  264. <h1>Coming soon<a class="headerlink" href="#coming-soon" title="Permalink to this heading"></a></h1>
    265. 

  265. <hr class="docutils" />
    266. 

  266. <ul class="simple">
    267. 

  267. <li><p>[ ] PP-LiteSeg recipes for Cityscapes with SOTA mIoU scores (~1.5% above paper)🎯</p></li>
    268. 

  268. <li><p>[ ] Single class detectors (recipes, pre-trained checkpoints) for edge devices deployment.</p></li>
    269. 

  269. <li><p>[ ] Single class segmentation (recipes, pre-trained checkpoints) for edge devices deployment.</p></li>
    270. 

  270. <li><p>[ ] QAT capabilities (Quantization Aware Training).</p></li>
    271. 

  271. <li><p>[ ] Integration with more professional tools.</p></li>
    272. 

  272. </ul>
    273. 

  273. </div>
    274. 

  274. <div class="section" id="table-of-content">
    275. 

  275. <h1>Table of Content<a class="headerlink" href="#table-of-content" title="Permalink to this heading"></a></h1>
    276. 

  276. <hr class="docutils" />
    277. 

  277. <!-- toc -->
    278. 

  278. <ul class="simple">
    279. 

  279. <li><p><span class="xref myst">Getting Started</span></p></li>
    280. 

  280. <li><p><span class="xref myst">Advanced Features</span></p></li>
    281. 

  281. <li><p><span class="xref myst">Installation Methods</span></p>
    282. 

  282. <ul>
    283. 

  283. <li><p><span class="xref myst">Prerequisites</span></p></li>
    284. 

  284. <li><p><span class="xref myst">Quick Installation</span></p></li>
    285. 

  285. </ul>
    286. 

  286. </li>
    287. 

  287. <li><p><span class="xref myst">Implemented Model Architectures</span></p></li>
    288. 

  288. <li><p><span class="xref myst">Contributing</span></p></li>
    289. 

  289. <li><p><span class="xref myst">Citation</span></p></li>
    290. 

  290. <li><p><span class="xref myst">Community</span></p></li>
    291. 

  291. <li><p><span class="xref myst">License</span></p></li>
    292. 

  292. <li><p><span class="xref myst">Deci Platform</span></p></li>
    293. 

  293. </ul>
    294. 

  294. <!-- tocstop -->
    295. 

  295. </div>
    296. 

  296. <div class="section" id="getting-started">
    297. 

  297. <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading"></a></h1>
    298. 

  298. <hr class="docutils" />
    299. 

  299. <div class="section" id="start-training-with-just-1-command-line">
    300. 

  300. <h2>Start Training with Just 1 Command Line<a class="headerlink" href="#start-training-with-just-1-command-line" title="Permalink to this heading"></a></h2>
    301. 

  301. <p>The most simple and straightforward way to start training SOTA performance models with SuperGradients reproducible recipes. Just define your dataset path and where you want your checkpoints to be saved and you are good to go from your terminal!</p>
    302. 

  302. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python -m super_gradients.train_from_recipe --config-name<span class="o">=</span>imagenet_regnetY <span class="nv">architecture</span><span class="o">=</span>regnetY800 dataset_interface.data_dir<span class="o">=</span>&lt;YOUR_Imagenet_LOCAL_PATH&gt; <span class="nv">ckpt_root_dir</span><span class="o">=</span>&lt;CHEKPOINT_DIRECTORY&gt;
    303. 

  303. </pre></div>
    304. 

  304. </div>
    305. 

  305. </div>
    306. 

  306. <div class="section" id="quickly-load-pre-trained-weights-for-your-desired-model-with-sota-performance">
    307. 

  307. <h2>Quickly Load Pre-Trained Weights for Your Desired Model with SOTA Performance<a class="headerlink" href="#quickly-load-pre-trained-weights-for-your-desired-model-with-sota-performance" title="Permalink to this heading"></a></h2>
    308. 

  308. <p>Want to try our pre-trained models on your machine? Import SuperGradients, initialize your Trainer, and load your desired architecture and pre-trained weights from our <span class="xref myst">SOTA model zoo</span></p>
    309. 

  309. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># The pretrained_weights argument will load a pre-trained architecture on the provided dataset</span>
    310. 

  310.     
    311. 

  311. <span class="kn">import</span> <span class="nn">super_gradients</span>
    312. 

  312. 

  313. <span class="n">model</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;model-name&quot;</span><span class="p">,</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;pretrained-model-name&quot;</span><span class="p">)</span>
    314. 

  314. 

  315. </pre></div>
    316. 

  316. </div>
    317. 

  317. </div>
    318. 

  318. <div class="section" id="id1">
    319. 

  319. <h2>Classification<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
    320. 

  320. <div class="section" id="transfer-learning">
    321. 

  321. <h3>Transfer Learning<a class="headerlink" href="#transfer-learning" title="Permalink to this heading"></a></h3>
    322. 

  322.   <table class="tfo-notebook-buttons" align="left">
    323. 

  323.  <td width="500">  
    324. 

  324.   <a target="_blank" href="https://bit.ly/3xzIutb"><img src="./assets/SG_img/colab_logo.png" /> Classification Transfer Learning</a>
    325. 

  325.   </td>
    326. 

  326.  <td width="200">    
    327. 

  327.  <a target="_blank" href="https://bit.ly/3xwYEn1"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    328. 

  328.  </td>
    329. 

  329. </table>
    330. 

  330.  </br></br>
    331. 

  331. </div>
    332. 

  332. </div>
    333. 

  333. <div class="section" id="id2">
    334. 

  334. <h2>Semantic Segmentation<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
    335. 

  335. <div class="section" id="quick-start">
    336. 

  336. <h3>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this heading"></a></h3>
    337. 

  337. <table class="tfo-notebook-buttons" align="left">
    338. 

  338.  <td width="500">
    339. 

  339. <a target="_blank" href="https://bit.ly/3qKx9m8"><img src="./assets/SG_img/colab_logo.png" /> Segmentation Quick Start</a>
    340. 

  340.  </td>
    341. 

  341.  <td width="200">
    342. 

  342. <a target="_blank" href="https://bit.ly/3qJjxYq"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source </a>
    343. 

  343.  </td>
    344. 

  344. </table>
    345. 

  345.  </br></br>
    346. 

  346. </div>
    347. 

  347. <div class="section" id="id3">
    348. 

  348. <h3>Transfer Learning<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
    349. 

  349. <table class="tfo-notebook-buttons" align="left">
    350. 

  350.  <td width="500">
    351. 

  351. <a target="_blank" href="https://bit.ly/3qKwMbe"><img src="./assets/SG_img/colab_logo.png" /> Segmentation Transfer Learning</a>
    352. 

  352.  </td>
    353. 

  353.  <td width="200">
    354. 

  354. <a target="_blank" href="https://bit.ly/3ShJlXn"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    355. 

  355.  </td>
    356. 

  356. </table>
    357. 

  357.  </br></br>
    358. 

  358. </div>
    359. 

  359. <div class="section" id="how-to-connect-custom-dataset">
    360. 

  360. <h3>How to Connect Custom Dataset<a class="headerlink" href="#how-to-connect-custom-dataset" title="Permalink to this heading"></a></h3>
    361. 

  361.   <table class="tfo-notebook-buttons" align="left">
    362. 

  362.  <td width="500"> 
    363. 

  363. <a target="_blank" href="https://bit.ly/3QQBVJp"><img src="./assets/SG_img/colab_logo.png" /> Segmentation How to Connect Custom Dataset</a>
    364. 

  364.    </td>
    365. 

  365.  <td width="200">
    366. 

  366.  <a target="_blank" href="https://bit.ly/3Us2WGi"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    367. 

  367.  </td>
    368. 

  368. </table>
    369. 

  369.  </br></br>
    370. 

  370. </div>
    371. 

  371. </div>
    372. 

  372. <div class="section" id="id4">
    373. 

  373. <h2>Object Detection<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h2>
    374. 

  374. <div class="section" id="id5">
    375. 

  375. <h3>Transfer Learning<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
    376. 

  376.   <table class="tfo-notebook-buttons" align="left">
    377. 

  377.  <td width="500">   
    378. 

  378. <a target="_blank" href="https://bit.ly/3SkMohx"><img src="./assets/SG_img/colab_logo.png" /> Detection Transfer Learning</a>
    379. 

  379.    </td>
    380. 

  380.  <td width="200">   
    381. 

  381. <a target="_blank" href="https://bit.ly/3DF8siG"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    382. 

  382.  </td>
    383. 

  383. </table>
    384. 

  384.  </br></br>
    385. 

  385. </div>
    386. 

  386. <div class="section" id="id6">
    387. 

  387. <h3>How to Connect Custom Dataset<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
    388. 

  388.   <table class="tfo-notebook-buttons" align="left">
    389. 

  389.  <td width="500">  
    390. 

  390.   <a target="_blank" href="https://bit.ly/3dqDlg3"><img src="./assets/SG_img/colab_logo.png" /> Detection How to Connect Custom Dataset</a>
    391. 

  391.   </td>
    392. 

  392.  <td width="200">      
    393. 

  393. <a target="_blank" href="https://bit.ly/3xBlcmq"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    394. 

  394.  </td>
    395. 

  395. </table>
    396. 

  396.  </br></br>
    397. 

  397. </div>
    398. 

  398. </div>
    399. 

  399. <div class="section" id="how-to-predict-using-pre-trained-model">
    400. 

  400. <h2>How to Predict Using Pre-trained Model<a class="headerlink" href="#how-to-predict-using-pre-trained-model" title="Permalink to this heading"></a></h2>
    401. 

  401. <div class="section" id="segmentation-detection-and-classification-prediction">
    402. 

  402. <h3>Segmentation, Detection and Classification Prediction<a class="headerlink" href="#segmentation-detection-and-classification-prediction" title="Permalink to this heading"></a></h3>
    403. 

  403.   <table class="tfo-notebook-buttons" align="left">
    404. 

  404.  <td width="500">    
    405. 

  405. <a target="_blank" href="https://bit.ly/3f4mssd"><img src="./assets/SG_img/colab_logo.png" /> How to Predict Using Pre-trained Model</a>
    406. 

  406.   </td>
    407. 

  407.  <td width="200">   
    408. 

  408. <a target="_blank" href="https://bit.ly/3Sf59Tr"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    409. 

  409.  </td>
    410. 

  410. </table>
    411. 

  411.  </br></br>
    412. 

  412. </div>
    413. 

  413. </div>
    414. 

  414. </div>
    415. 

  415. <div class="section" id="advanced-features">
    416. 

  416. <h1>Advanced Features<a class="headerlink" href="#advanced-features" title="Permalink to this heading"></a></h1>
    417. 

  417. <hr class="docutils" />
    418. 

  418. <div class="section" id="knowledge-distillation-training">
    419. 

  419. <h2>Knowledge Distillation Training<a class="headerlink" href="#knowledge-distillation-training" title="Permalink to this heading"></a></h2>
    420. 

  420. <p>Knowledge Distillation is a training technique that uses a large model, teacher model, to improve the performance of a smaller model, the student model.
    421. 

  421. Learn more about SuperGradients knowledge distillation training with our pre-trained BEiT base teacher model and Resnet18 student model on CIFAR10 example notebook on Google Colab for an easy to use tutorial using free GPU hardware</p>
    422. 

  422.   <table class="tfo-notebook-buttons" align="left">
    423. 

  423.  <td width="500">   
    424. 

  424.    <a target="_blank" href="https://bit.ly/3BLA5oR"><img src="./assets/SG_img/colab_logo.png" /> Knowledge Distillation Training</a>
    425. 

  425.   </td>
    426. 

  426.  <td width="200">   
    427. 

  427. <a target="_blank" href="https://bit.ly/3S9UlG4"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    428. 

  428.  </td>
    429. 

  429. </table>
    430. 

  430.  </br></br>
    431. 

  431. </div>
    432. 

  432. <div class="section" id="recipes">
    433. 

  433. <h2>Recipes<a class="headerlink" href="#recipes" title="Permalink to this heading"></a></h2>
    434. 

  434. <p>To train a model, it is necessary to configure 4 main components. These components are aggregated into a single “main” recipe <code class="docutils literal notranslate"><span class="pre">.yaml</span></code> file that inherits the aforementioned dataset, architecture, raining and checkpoint params. It is also possible (and recomended for flexibility) to override default settings with custom ones.
    435. 

  435. All recipes can be found <span class="xref myst">here</span></p>
    436. 

  436.   <table class="tfo-notebook-buttons" align="left">
    437. 

  437.  <td width="500">   
    438. 

  438.    <a target="_blank" href="https://bit.ly/3UiY5ab"><img src="./assets/SG_img/colab_logo.png" /> How to Use Recipes</a>
    439. 

  439.   </td>
    440. 

  440.  <td width="200">  
    441. 

  441. <a target="_blank" href="https://bit.ly/3QSrHbm"><img src="./assets/SG_img/GitHub_logo.png" /> GitHub source</a>
    442. 

  442.  </td>
    443. 

  443. </table>
    444. 

  444.  </br></br>
    445. 

  445. </div>
    446. 

  446. <div class="section" id="using-ddp">
    447. 

  447. <h2>Using DDP<a class="headerlink" href="#using-ddp" title="Permalink to this heading"></a></h2>
    448. 

  448. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">super_gradients</span> <span class="kn">import</span> <span class="n">init_trainer</span>
    449. 

  449. <span class="kn">from</span> <span class="nn">super_gradients.common</span> <span class="kn">import</span> <span class="n">MultiGPUMode</span>
    450. 

  450. <span class="kn">from</span> <span class="nn">super_gradients.training.utils.distributed_training_utils</span> <span class="kn">import</span> <span class="n">setup_gpu_mode</span>
    451. 

  451. 

  452. <span class="c1"># Initialize the environment</span>
    453. 

  453. <span class="n">init_trainer</span><span class="p">()</span>
    454. 

  454. 

  455. <span class="c1"># Launch DDP on 1 device (node) of 4 GPU&#39;s</span>
    456. 

  456. <span class="n">setup_gpu_mode</span><span class="p">(</span><span class="n">gpu_mode</span><span class="o">=</span><span class="n">MultiGPUMode</span><span class="o">.</span><span class="n">DISTRIBUTED_DATA_PARALLEL</span><span class="p">,</span> <span class="n">num_gpus</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
    457. 

  457. 

  458. <span class="c1"># Define the objects</span>
    459. 

  459. 

  460. <span class="c1"># The trainer will run on DDP without anything else to change</span>
    461. 

  461. </pre></div>
    462. 

  462. </div>
    463. 

  463. </div>
    464. 

  464. <div class="section" id="easily-change-architectures-parameters">
    465. 

  465. <h2>Easily change architectures parameters<a class="headerlink" href="#easily-change-architectures-parameters" title="Permalink to this heading"></a></h2>
    466. 

  466. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">super_gradients.training</span> <span class="kn">import</span> <span class="n">models</span>
    467. 

  467. 

  468. <span class="c1"># instantiate default pretrained resnet18</span>
    469. 

  469. <span class="n">default_resnet18</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;resnet18&quot;</span><span class="p">,</span> <span class="n">num_classes</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;imagenet&quot;</span><span class="p">)</span>
    470. 

  470. 

  471. <span class="c1"># instantiate pretrained resnet18, turning DropPath on with probability 0.5</span>
    472. 

  472. <span class="n">droppath_resnet18</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;resnet18&quot;</span><span class="p">,</span> <span class="n">arch_params</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;droppath_prob&quot;</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">},</span> <span class="n">num_classes</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;imagenet&quot;</span><span class="p">)</span>
    473. 

  473. 

  474. <span class="c1"># instantiate pretrained resnet18, without classifier head. Output will be from the last stage before global pooling</span>
    475. 

  475. <span class="n">backbone_resnet18</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;resnet18&quot;</span><span class="p">,</span> <span class="n">arch_params</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;backbone_mode&quot;</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="n">pretrained_weights</span><span class="o">=</span><span class="s2">&quot;imagenet&quot;</span><span class="p">)</span>
    476. 

  476. </pre></div>
    477. 

  477. </div>
    478. 

  478. </div>
    479. 

  479. <div class="section" id="using-phase-callbacks">
    480. 

  480. <h2>Using phase callbacks<a class="headerlink" href="#using-phase-callbacks" title="Permalink to this heading"></a></h2>
    481. 

  481. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">super_gradients</span> <span class="kn">import</span> <span class="n">Trainer</span>
    482. 

  482. <span class="kn">from</span> <span class="nn">torch.optim.lr_scheduler</span> <span class="kn">import</span> <span class="n">ReduceLROnPlateau</span>
    483. 

  483. <span class="kn">from</span> <span class="nn">super_gradients.training.utils.callbacks</span> <span class="kn">import</span> <span class="n">Phase</span><span class="p">,</span> <span class="n">LRSchedulerCallback</span>
    484. 

  484. <span class="kn">from</span> <span class="nn">super_gradients.training.metrics.classification_metrics</span> <span class="kn">import</span> <span class="n">Accuracy</span>
    485. 

  485. 

  486. <span class="c1"># define PyTorch train and validation loaders and optimizer</span>
    487. 

  487. 

  488. <span class="c1"># define what to be called in the callback</span>
    489. 

  489. <span class="n">rop_lr_scheduler</span> <span class="o">=</span> <span class="n">ReduceLROnPlateau</span><span class="p">(</span><span class="n">optimizer</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;max&quot;</span><span class="p">,</span> <span class="n">patience</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    490. 

  490. 

  491. <span class="c1"># define phase callbacks, they will fire as defined in Phase</span>
    492. 

  492. <span class="n">phase_callbacks</span> <span class="o">=</span> <span class="p">[</span><span class="n">LRSchedulerCallback</span><span class="p">(</span><span class="n">scheduler</span><span class="o">=</span><span class="n">rop_lr_scheduler</span><span class="p">,</span>
    493. 

  493.                                        <span class="n">phase</span><span class="o">=</span><span class="n">Phase</span><span class="o">.</span><span class="n">VALIDATION_EPOCH_END</span><span class="p">,</span>
    494. 

  494.                                        <span class="n">metric_name</span><span class="o">=</span><span class="s2">&quot;Accuracy&quot;</span><span class="p">)]</span>
    495. 

  495. 

  496. <span class="c1"># create a trainer object, look the declaration for more parameters</span>
    497. 

  497. <span class="n">trainer</span> <span class="o">=</span> <span class="n">Trainer</span><span class="p">(</span><span class="s2">&quot;experiment_name&quot;</span><span class="p">)</span>
    498. 

  498. 

  499. <span class="c1"># define phase_callbacks as part of the training parameters</span>
    500. 

  500. <span class="n">train_params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;phase_callbacks&quot;</span><span class="p">:</span> <span class="n">phase_callbacks</span><span class="p">}</span>
    501. 

  501. </pre></div>
    502. 

  502. </div>
    503. 

  503. </div>
    504. 

  504. <div class="section" id="integration-to-weights-and-biases">
    505. 

  505. <h2>Integration to Weights and Biases<a class="headerlink" href="#integration-to-weights-and-biases" title="Permalink to this heading"></a></h2>
    506. 

  506. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">super_gradients</span> <span class="kn">import</span> <span class="n">Trainer</span>
    507. 

  507. 

  508. <span class="c1"># create a trainer object, look the declaration for more parameters</span>
    509. 

  509. <span class="n">trainer</span> <span class="o">=</span> <span class="n">Trainer</span><span class="p">(</span><span class="s2">&quot;experiment_name&quot;</span><span class="p">)</span>
    510. 

  510. 

  511. <span class="n">train_params</span> <span class="o">=</span> <span class="p">{</span> <span class="o">...</span> <span class="c1"># training parameters</span>
    512. 

  512.                 <span class="s2">&quot;sg_logger&quot;</span><span class="p">:</span> <span class="s2">&quot;wandb_sg_logger&quot;</span><span class="p">,</span> <span class="c1"># Weights&amp;Biases Logger, see class WandBSGLogger for details</span>
    513. 

  513.                 <span class="s2">&quot;sg_logger_params&quot;</span><span class="p">:</span> <span class="c1"># paramenters that will be passes to __init__ of the logger </span>
    514. 

  514.                   <span class="p">{</span>
    515. 

  515.                     <span class="s2">&quot;project_name&quot;</span><span class="p">:</span> <span class="s2">&quot;project_name&quot;</span><span class="p">,</span> <span class="c1"># W&amp;B project name</span>
    516. 

  516.                     <span class="s2">&quot;save_checkpoints_remote&quot;</span><span class="p">:</span> <span class="kc">True</span>
    517. 

  517.                     <span class="s2">&quot;save_tensorboard_remote&quot;</span><span class="p">:</span> <span class="kc">True</span>
    518. 

  518.                     <span class="s2">&quot;save_logs_remote&quot;</span><span class="p">:</span> <span class="kc">True</span>
    519. 

  519.                   <span class="p">}</span> 
    520. 

  520.                <span class="p">}</span>
    521. 

  521. </pre></div>
    522. 

  522. </div>
    523. 

  523. </div>
    524. 

  524. </div>
    525. 

  525. <div class="section" id="installation-methods">
    526. 

  526. <h1>Installation Methods<a class="headerlink" href="#installation-methods" title="Permalink to this heading"></a></h1>
    527. 

  527. <hr class="docutils" />
    528. 

  528. <div class="section" id="prerequisites">
    529. 

  529. <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this heading"></a></h2>
    530. 

  530. <details>
    531. 

  531. <summary>General requirements</summary>
    532. 

  532. <ul class="simple">
    533. 

  533. <li><p>Python 3.7, 3.8 or 3.9 installed.</p></li>
    534. 

  534. <li><p>torch&gt;=1.9.0</p>
    535. 

  535. <ul>
    536. 

  536. <li><p>https://pytorch.org/get-started/locally/</p></li>
    537. 

  537. </ul>
    538. 

  538. </li>
    539. 

  539. <li><p>The python packages that are specified in requirements.txt;</p></li>
    540. 

  540. </ul>
    541. 

  541. </details>
    542. 

  542. <details>
    543. 

  543. <summary>To train on nvidia GPUs</summary>
    544. 

  544. <ul class="simple">
    545. 

  545. <li><p><a class="reference external" href="https://developer.nvidia.com/cuda-11.2.0-download-archive?target_os=Linux&amp;target_arch=x86_64&amp;target_distro=Ubuntu">Nvidia CUDA Toolkit &gt;= 11.2</a></p></li>
    546. 

  546. <li><p>CuDNN &gt;= 8.1.x</p></li>
    547. 

  547. <li><p>Nvidia Driver with CUDA &gt;= 11.2 support (≥460.x)</p></li>
    548. 

  548. </ul>
    549. 

  549. </details>
    550. 

  550. </div>
    551. 

  551. <div class="section" id="id7">
    552. 

  552. <h2>Quick Installation<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h2>
    553. 

  553. <details>
    554. 

  554. <summary>Install stable version using PyPi</summary>
    555. 

  555. <p>See in <a class="reference external" href="https://pypi.org/project/super-gradients/">PyPi</a></p>
    556. 

  556. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install super-gradients
    557. 

  557. </pre></div>
    558. 

  558. </div>
    559. 

  559. <p>That’s it !</p>
    560. 

  560. </details>
    561. 

  561. <details>
    562. 

  562. <summary>Install using GitHub</summary>
    563. 

  563. <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install git+https://github.com/Deci-AI/super-gradients.git@stable
    564. 

  564. </pre></div>
    565. 

  565. </div>
    566. 

  566. </details> 
    567. 

  567. </div>
    568. 

  568. </div>
    569. 

  569. <div class="section" id="implemented-model-architectures">
    570. 

  570. <h1>Implemented Model Architectures<a class="headerlink" href="#implemented-model-architectures" title="Permalink to this heading"></a></h1>
    571. 

  571. <hr class="docutils" />
    572. 

  572. <p>Detailed list can be found <span class="xref myst">here</span></p>
    573. 

  573. <div class="section" id="image-classification">
    574. 

  574. <h2>Image Classification<a class="headerlink" href="#image-classification" title="Permalink to this heading"></a></h2>
    575. 

  575. <ul class="simple">
    576. 

  576. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/densenet.py">DensNet (Densely Connected Convolutional Networks)</a></p></li>
    577. 

  577. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/dpn.py">DPN</a></p></li>
    578. 

  578. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/efficientnet.py">EfficientNet</a></p></li>
    579. 

  579. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/lenet.py">LeNet</a></p></li>
    580. 

  580. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/mobilenet.py">MobileNet</a></p></li>
    581. 

  581. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/mobilenetv2.py">MobileNet v2</a></p></li>
    582. 

  582. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/mobilenetv3.py">MobileNet v3</a></p></li>
    583. 

  583. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/pnasnet.py">PNASNet</a></p></li>
    584. 

  584. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/preact_resnet.py">Pre-activation ResNet</a></p></li>
    585. 

  585. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/regnet.py">RegNet</a></p></li>
    586. 

  586. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/repvgg.py">RepVGG</a></p></li>
    587. 

  587. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/resnet.py">ResNet</a></p></li>
    588. 

  588. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/resnext.py">ResNeXt</a></p></li>
    589. 

  589. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/senet.py">SENet </a></p></li>
    590. 

  590. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/shufflenet.py">ShuffleNet</a></p></li>
    591. 

  591. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/shufflenetv2.py">ShuffleNet v2</a></p></li>
    592. 

  592. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/classification_models/vgg.py">VGG</a></p></li>
    593. 

  593. </ul>
    594. 

  594. </div>
    595. 

  595. <div class="section" id="id8">
    596. 

  596. <h2>Semantic Segmentation<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h2>
    597. 

  597. <ul class="simple">
    598. 

  598. <li><p><a class="reference external" href="https://bit.ly/3RrtMMO">PP-LiteSeg</a></p></li>
    599. 

  599. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/segmentation_models/ddrnet.py">DDRNet (Deep Dual-resolution Networks)</a></p></li>
    600. 

  600. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/segmentation_models/laddernet.py">LadderNet</a></p></li>
    601. 

  601. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/segmentation_models/regseg.py">RegSeg</a></p></li>
    602. 

  602. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/segmentation_models/shelfnet.py">ShelfNet</a></p></li>
    603. 

  603. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/segmentation_models/stdc.py">STDC</a></p></li>
    604. 

  604. </ul>
    605. 

  605. </div>
    606. 

  606. <div class="section" id="id9">
    607. 

  607. <h2>Object Detection<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h2>
    608. 

  608. <ul class="simple">
    609. 

  609. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/detection_models/csp_darknet53.py">CSP DarkNet</a></p></li>
    610. 

  610. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/detection_models/darknet53.py">DarkNet-53</a></p></li>
    611. 

  611. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/detection_models/ssd.py">SSD (Single Shot Detector)</a></p></li>
    612. 

  612. <li><p><a class="reference external" href="https://github.com/Deci-AI/super-gradients/blob/master/src/super_gradients/training/models/detection_models/yolox.py">YOLOX</a></p></li>
    613. 

  613. </ul>
    614. 

  614. <hr class="docutils" />
    615. 

  615. </div>
    616. 

  616. </div>
    617. 

  617. <div class="section" id="documentation">
    618. 

  618. <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1>
    619. 

  619. <p>Check SuperGradients <a class="reference external" href="https://deci-ai.github.io/super-gradients/welcome.html">Docs</a> for full documentation, user guide, and examples.</p>
    620. 

  620. </div>
    621. 

  621. <div class="section" id="contributing">
    622. 

  622. <h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading"></a></h1>
    623. 

  623. <p>To learn about making a contribution to SuperGradients, please see our <a class="reference internal" href="CONTRIBUTING.html"><span class="doc std std-doc">Contribution page</span></a>.</p>
    624. 

  624. <p>Our awesome contributors:</p>
    625. 

  625. <a href="https://github.com/Deci-AI/super-gradients/graphs/contributors">
    626. 

  626.   <img src="https://contrib.rocks/image?repo=Deci-AI/super-gradients" />
    627. 

  627. </a>
    628. 

  628. <p><br/>Made with <a class="reference external" href="https://contrib.rocks">contrib.rocks</a>.</p>
    629. 

  629. </div>
    630. 

  630. <div class="section" id="citation">
    631. 

  631. <h1>Citation<a class="headerlink" href="#citation" title="Permalink to this heading"></a></h1>
    632. 

  632. <p>If you are using SuperGradients library or benchmarks in your research, please cite SuperGradients deep learning training library.</p>
    633. 

  633. </div>
    634. 

  634. <div class="section" id="community">
    635. 

  635. <h1>Community<a class="headerlink" href="#community" title="Permalink to this heading"></a></h1>
    636. 

  636. <p>If you want to be a part of SuperGradients growing community, hear about all the exciting news and updates, need help, request for advanced features,
    637. 

  637. or want to file a bug or issue report, we would love to welcome you aboard!</p>
    638. 

  638. <ul class="simple">
    639. 

  639. <li><p>Slack is the place to be and ask questions about SuperGradients and get support. <a class="reference external" href="https://join.slack.com/t/supergradients-comm52/shared_invite/zt-10vz6o1ia-b_0W5jEPEnuHXm087K~t8Q">Click here to join our Slack</a></p></li>
    640. 

  640. <li><p>To report a bug, <a class="reference external" href="https://github.com/Deci-AI/super-gradients/issues">file an issue</a> on GitHub.</p></li>
    641. 

  641. <li><p>Join the <a class="reference external" href="https://www.supergradients.com/#Newsletter">SG Newsletter</a>
    642. 

  642. for staying up to date with new features and models, important announcements, and upcoming events.</p></li>
    643. 

  643. <li><p>For a short meeting with us, use this <a class="reference external" href="https://calendly.com/ofer-baratz-deci/15min">link</a> and choose your preferred time.</p></li>
    644. 

  644. </ul>
    645. 

  645. </div>
    646. 

  646. <div class="section" id="license">
    647. 

  647. <h1>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h1>
    648. 

  648. <p>This project is released under the <a class="reference internal" href="LICENSE.html"><span class="doc std std-doc">Apache 2.0 license</span></a>.</p>
    649. 

  649. <hr class="docutils" />
    650. 

  650. </div>
    651. 

  651. <div class="section" id="deci-platform">
    652. 

  652. <h1>Deci Platform<a class="headerlink" href="#deci-platform" title="Permalink to this heading"></a></h1>
    653. 

  653. <p>Deci Platform is our end to end platform for building, optimizing and deploying deep learning models to production.</p>
    654. 

  654. <p><a class="reference external" href="https://bit.ly/3qO3icq">Request free trial</a> to enjoy immediate improvement in throughput, latency, memory footprint and model size.</p>
    655. 

  655. <p>Features:</p>
    656. 

  656. <ul class="simple">
    657. 

  657. <li><p>Automatically compile and quantize your models with just a few clicks (TensorRT, OpenVINO).</p></li>
    658. 

  658. <li><p>Gain up to 10X improvement in throughput, latency, memory and model size.</p></li>
    659. 

  659. <li><p>Easily benchmark your models’ performance on different hardware and batch sizes.</p></li>
    660. 

  660. <li><p>Invite co-workers to collaborate on models and communicate your progress.</p></li>
    661. 

  661. <li><p>Deci supports all common frameworks and Hardware, from Intel CPUs to Nvidia’s GPUs and Jetsons.
    662. 

  662. ֿ</p></li>
    663. 

  663. </ul>
    664. 

  664. <p>Request free trial <a class="reference external" href="https://bit.ly/3qO3icq">here</a></p>
    665. 

  665. </div>
    666. 

  666. 

  667. 

  668.            </div>
    669. 

  669.           </div>
    670. 

  670.           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
    671. 

  671.         <a href="index.html" class="btn btn-neutral float-left" title="Welcome to SuperGradients’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    672. 

  672.         <a href="super_gradients.common.html" class="btn btn-neutral float-right" title="Common package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    673. 

  673.     </div>
    674. 

  674. 

  675.   <hr/>
    676. 

  676. 

  677.   <div role="contentinfo">
    678. 

  678.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    679. 

  679.   </div>
    680. 

  680. 

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

  682.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    683. 

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

  684.    
    685. 

  685. 

  686. </footer>
    687. 

  687.         </div>
    688. 

  688.       </div>
    689. 

  689.     </section>
    690. 

  690.   </div>
    691. 

  691.   <script>
    692. 

  692.       jQuery(function () {
    693. 

  693.           SphinxRtdTheme.Navigation.enable(true);
    694. 

  694.       });
    695. 

  695.   </script> 
    696. 

  696. 

  697. </body>
    698. 

  698. </html>
    699.
Prev
Next
Tip!

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

Comments

Write Preview
Loading...
Integrate AWS S3
Use S3 remote
Select bucket
Access key
Finish

Use AWS S3 as storage!

Browsing data directories saved to S3 is possible with DAGsHub. Let's configure your repository to easily display your data in the context of any commit!

Specify your S3 bucket

Access key (If needed)

Congratulations!

super-gradients is now integrated with AWS S3!

Delete Storage Key

Are you sure you want to delete this access key?

No
Yes
Integrate Google Cloud Storage
Use Google Storage
Select bucket
Upload key
Finish

Use Google Cloud Storage!

Browsing data directories saved to Google Cloud Storage is possible with DAGsHub. Let's configure your repository to easily display your data in the context of any commit!

Specify your Google Storage bucket

Service Account Key

Congratulations!

super-gradients is now integrated with Google Cloud Storage!

Delete Storage Key

Are you sure you want to delete this access key?

No
Yes
Integrate Azure Cloud Storage
Use Azure Storage
Select bucket
Set key
Finish

Use Azure Cloud Storage!

Browsing data directories saved to Azure Cloud Storage is possible with DAGsHub. Let's configure your repository to easily display your data in the context of any commit!

Specify your Azure Storage bucket

Access key (If needed)

Congratulations!

super-gradients is now integrated with Azure Cloud Storage!

Delete Storage Key

Are you sure you want to delete this access key?

No
Yes
Integrate S3 compatible storage
Use S3 like remote
Select bucket
Access key
Finish

Use any S3 compatible storage!

Browsing data directories saved to S3 compatible storage is possible with DAGsHub. Let's configure your repository to easily display your data in the context of any commit!

Specify your S3 bucket

Bucket name cannot be the same as the repository name. Please change one of them.

Access key (If needed)

Congratulations!

super-gradients is now integrated with your S3 compatible storage!

Delete Storage Key

Are you sure you want to delete this access key?

No
Yes