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

#406 Feature/SG 293 - Add register loss

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:feature/SG-293-register_loss
Conversation 0 Files changed 4 Commits 1
File Compare
super-gradients
/
docs
/
_modules
/
super_gradients
/
training
/
exceptions
/
sg_model_exceptions.html
View left file View right file
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150 
  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>super_gradients.training.exceptions.sg_model_exceptions &mdash; SuperGradients 1.0 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.   <!--[if lt IE 9]>
    11. 

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

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

  13.   
    14. 

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

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

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

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

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

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

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

  21. </head>
    22. 

  22. 

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

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

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

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

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

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

  29.           </a>
    30. 

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

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

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

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

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

  35.   </form>
    36. 

  36. </div>
    37. 

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

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

  39. <ul>
    40. 

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

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

  42. </ul>
    43. 

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

  44. <ul>
    45. 

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

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

  47. </ul>
    48. 

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

  49. <ul>
    50. 

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

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

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

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

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

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

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

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

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

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

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

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

  62. </ul>
    63. 

  63. 

  64.         </div>
    65. 

  65.       </div>
    66. 

  66.     </nav>
    67. 

  67. 

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

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

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

  71.       </nav>
    72. 

  72. 

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

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

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

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

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

  78.           <li><a href="../../../index.html">Module code</a> &raquo;</li>
    79. 

  79.       <li>super_gradients.training.exceptions.sg_model_exceptions</li>
    80. 

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

  81.       </li>
    82. 

  82.   </ul>
    83. 

  83.   <hr/>
    84. 

  84. </div>
    85. 

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

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

  87.              
    88. 

  88.   <h1>Source code for super_gradients.training.exceptions.sg_model_exceptions</h1><div class="highlight"><pre>
    89. 

  89. <span></span>
    90. 

  90. <div class="viewcode-block" id="UnsupportedTrainingParameterFormat"><a class="viewcode-back" href="../../../../super_gradients.training.exceptions.html#super_gradients.training.exceptions.sg_model_exceptions.UnsupportedTrainingParameterFormat">[docs]</a><span class="k">class</span> <span class="nc">UnsupportedTrainingParameterFormat</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    91. 

  91.     <span class="sd">&quot;&quot;&quot;Exception raised illegal training param format.</span>
    92. 

  92. 

  93. <span class="sd">    Attributes:</span>
    94. 

  94. <span class="sd">        message -- explanation of the error</span>
    95. 

  95. <span class="sd">    &quot;&quot;&quot;</span>
    96. 

  96. 

  97.     <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">desc</span><span class="p">):</span>
    98. 

  98.         <span class="bp">self</span><span class="o">.</span><span class="n">message</span> <span class="o">=</span> <span class="s2">&quot;Unsupported training parameter format: &quot;</span> <span class="o">+</span> <span class="n">desc</span>
    99. 

  99.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div>
    100. 

  100. 

  101. 

  102. <div class="viewcode-block" id="UnsupportedOptimizerFormat"><a class="viewcode-back" href="../../../../super_gradients.training.exceptions.html#super_gradients.training.exceptions.sg_model_exceptions.UnsupportedOptimizerFormat">[docs]</a><span class="k">class</span> <span class="nc">UnsupportedOptimizerFormat</span><span class="p">(</span><span class="n">UnsupportedTrainingParameterFormat</span><span class="p">):</span>
    103. 

  103.     <span class="sd">&quot;&quot;&quot;Exception raised illegal optimizer format.</span>
    104. 

  104. 

  105. <span class="sd">    Attributes:</span>
    106. 

  106. <span class="sd">        message -- explanation of the error</span>
    107. 

  107. <span class="sd">    &quot;&quot;&quot;</span>
    108. 

  108. 

  109.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    110. 

  110.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
    111. 

  111.             <span class="s2">&quot;optimizer parameter expected one of [&#39;Adam&#39;,&#39;SGD&#39;,&#39;RMSProp&#39;], or torch.optim.Optimizer object&quot;</span><span class="p">)</span></div>
    112. 

  112. 

  113. 

  114. <div class="viewcode-block" id="IllegalDataloaderInitialization"><a class="viewcode-back" href="../../../../super_gradients.training.exceptions.html#super_gradients.training.exceptions.sg_model_exceptions.IllegalDataloaderInitialization">[docs]</a><span class="k">class</span> <span class="nc">IllegalDataloaderInitialization</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    115. 

  115.     <span class="sd">&quot;&quot;&quot;Exception raised illegal data loaders.</span>
    116. 

  116. <span class="sd">    &quot;&quot;&quot;</span>
    117. 

  117. 

  118.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    119. 

  119.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
    120. 

  120.             <span class="s2">&quot;train_loader, valid_loader and class parameters are required when initializing SgModel with data loaders&quot;</span><span class="p">)</span></div>
    121. 

  121. </pre></div>
    122. 

  122. 

  123.            </div>
    124. 

  124.           </div>
    125. 

  125.           <footer>
    126. 

  126. 

  127.   <hr/>
    128. 

  128. 

  129.   <div role="contentinfo">
    130. 

  130.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    131. 

  131.   </div>
    132. 

  132. 

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

  134.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    135. 

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

  136.    
    137. 

  137. 

  138. </footer>
    139. 

  139.         </div>
    140. 

  140.       </div>
    141. 

  141.     </section>
    142. 

  142.   </div>
    143. 

  143.   <script>
    144. 

  144.       jQuery(function () {
    145. 

  145.           SphinxRtdTheme.Navigation.enable(true);
    146. 

  146.       });
    147. 

  147.   </script> 
    148. 

  148. 

  149. </body>
    150. 

  150. </html>
    151.
Discard
Prev
Next
Tip!

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