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

#561 Feature/sg 193 extend output formator

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

  25. 

  26. <body class="wy-body-for-nav"> 
    27. 

  27.   <div class="wy-grid-for-nav">
    28. 

  28.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    29. 

  29.       <div class="wy-side-scroll">
    30. 

  30.         <div class="wy-side-nav-search" >
    31. 

  31.             <a href="../../../../index.html" class="icon icon-home"> SuperGradients
    32. 

  32.           </a>
    33. 

  33. <div role="search">
    34. 

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

  35.     <input type="text" name="q" placeholder="Search docs" />
    36. 

  36.     <input type="hidden" name="check_keywords" value="yes" />
    37. 

  37.     <input type="hidden" name="area" value="default" />
    38. 

  38.   </form>
    39. 

  39. </div>
    40. 

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

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

  42. <ul>
    43. 

  43. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html">Version 3 is out! Notebooks have been updated!</a></li>
    44. 

  44. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#build-with-supergradients">Build with SuperGradients</a></li>
    45. 

  45. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#quick-installation">Quick Installation</a></li>
    46. 

  46. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#what-s-new">What’s New</a></li>
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#coming-soon">Coming soon</a></li>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#table-of-content">Table of Content</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#getting-started">Getting Started</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#advanced-features">Advanced Features</a></li>
    51. 

  51. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#installation-methods">Installation Methods</a></li>
    52. 

  52. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#implemented-model-architectures">Implemented Model Architectures</a></li>
    53. 

  53. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#documentation">Documentation</a></li>
    54. 

  54. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#contributing">Contributing</a></li>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#citation">Citation</a></li>
    56. 

  56. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#community">Community</a></li>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#license">License</a></li>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#deci-platform">Deci Platform</a></li>
    59. 

  59. </ul>
    60. 

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

  61. <ul>
    62. 

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

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

  64. </ul>
    65. 

  65. 

  66.         </div>
    67. 

  67.       </div>
    68. 

  68.     </nav>
    69. 

  69. 

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

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

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

  73.       </nav>
    74. 

  74. 

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

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

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

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

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

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

  81.       <li>super_gradients.common.decorators.singleton</li>
    82. 

  82.       <li class="wy-breadcrumbs-aside">
    83. 

  83.       </li>
    84. 

  84.   </ul>
    85. 

  85.   <hr/>
    86. 

  86. </div>
    87. 

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

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

  89.              
    90. 

  90.   <h1>Source code for super_gradients.common.decorators.singleton</h1><div class="highlight"><pre>
    91. 

  91. <span></span><span class="k">class</span> <span class="nc">SingletonMeta</span><span class="p">(</span><span class="nb">type</span><span class="p">):</span>
    92. 

  92.     <span class="sd">&quot;&quot;&quot;</span>
    93. 

  93. <span class="sd">    A Singleton meta class.</span>
    94. 

  94. <span class="sd">    A class that derives from this class will have only 1 instance of that type for the process.</span>
    95. 

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

  96. 

  97.     <span class="n">_instances</span> <span class="o">=</span> <span class="p">{}</span>
    98. 

  98. 

  99.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    100. 

  100.         <span class="k">if</span> <span class="bp">cls</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_instances</span><span class="p">:</span>
    101. 

  101.             <span class="bp">cls</span><span class="o">.</span><span class="n">_instances</span><span class="p">[</span><span class="bp">cls</span><span class="p">]</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">SingletonMeta</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span><span class="o">.</span><span class="fm">__call__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    102. 

  102.         <span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_instances</span><span class="p">[</span><span class="bp">cls</span><span class="p">]</span>
    103. 

  103. 

  104. 

  105. <span class="k">class</span> <span class="nc">_SingletonWrapper</span><span class="p">:</span>
    106. 

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

  107. <span class="sd">    A singleton wrapper class. Its instances would be created</span>
    108. 

  108. <span class="sd">    for each decorated class.</span>
    109. 

  109. <span class="sd">    &quot;&quot;&quot;</span>
    110. 

  110. 

  111.     <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="bp">cls</span><span class="p">):</span>
    112. 

  112.         <span class="bp">self</span><span class="o">.</span><span class="n">__wrapped__</span> <span class="o">=</span> <span class="bp">cls</span>
    113. 

  113.         <span class="bp">self</span><span class="o">.</span><span class="n">_instance</span> <span class="o">=</span> <span class="kc">None</span>
    114. 

  114. 

  115.     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
    116. 

  116.         <span class="sd">&quot;&quot;&quot;Returns a single instance of decorated class&quot;&quot;&quot;</span>
    117. 

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

  118.             <span class="bp">self</span><span class="o">.</span><span class="n">_instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__wrapped__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
    119. 

  119.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_instance</span>
    120. 

  120. 

  121. 

  122. <div class="viewcode-block" id="singleton"><a class="viewcode-back" href="../../../../super_gradients.common.html#super_gradients.common.singleton">[docs]</a><span class="k">def</span> <span class="nf">singleton</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
    123. 

  123.     <span class="sd">&quot;&quot;&quot;</span>
    124. 

  124. <span class="sd">    A singleton decorator. Returns a wrapper objects. A call on that object</span>
    125. 

  125. <span class="sd">    returns a single instance object of decorated class. Use the __wrapped__</span>
    126. 

  126. <span class="sd">    attribute to access decorated class directly in unit tests</span>
    127. 

  127. <span class="sd">    &quot;&quot;&quot;</span>
    128. 

  128.     <span class="k">return</span> <span class="n">_SingletonWrapper</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span></div>
    129. 

  129. </pre></div>
    130. 

  130. 

  131.            </div>
    132. 

  132.           </div>
    133. 

  133.           <footer>
    134. 

  134. 

  135.   <hr/>
    136. 

  136. 

  137.   <div role="contentinfo">
    138. 

  138.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    139. 

  139.   </div>
    140. 

  140. 

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

  142.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    143. 

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

  144.    
    145. 

  145. 

  146. </footer>
    147. 

  147.         </div>
    148. 

  148.       </div>
    149. 

  149.     </section>
    150. 

  150.   </div>
    151. 

  151.   <script>
    152. 

  152.       jQuery(function () {
    153. 

  153.           SphinxRtdTheme.Navigation.enable(true);
    154. 

  154.       });
    155. 

  155.   </script> 
    156. 

  156. 

  157. </body>
    158. 

  158. </html>
    159.
Discard
Prev
Next
Tip!

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