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

#208 detection transforms and their utils added

Merged
Shay Aharon merged 1 commits into Deci-AI:master from deci-ai:feature/SG-13_detection_tranforms
Conversation 0 Files changed 4 Commits 1
File Compare
super-gradients
/
docs
/
super_gradients.common.html
View left file View right file
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374 
  1. <!DOCTYPE html>
    2. 

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

  3. <head>
    4. 

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

  5. 

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

  7.   <title>Common package &mdash; SuperGradients 1.0 documentation</title>
    8. 

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

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

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

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

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

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

  14.   
    15. 

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

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

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

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

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

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

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

  22.     <link rel="next" title="Training package" href="super_gradients.training.html" />
    23. 

  23. </head>
    24. 

  24. 

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

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

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

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

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

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

  31.           </a>
    32. 

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

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

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

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

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

  37.   </form>
    38. 

  38. </div>
    39. 

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

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

  41. <ul>
    42. 

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

  43. </ul>
    44. 

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

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

  46. <li class="toctree-l1 current"><a class="current reference internal" href="#">Common package</a><ul>
    47. 

  47. <li class="toctree-l2"><a class="reference internal" href="#module-contents">Module contents</a></li>
    48. 

  48. </ul>
    49. 

  49. </li>
    50. 

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

  51. </ul>
    52. 

  52. <p class="caption"><span class="caption-text">User Guide</span></p>
    53. 

  53. <ul>
    54. 

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

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

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

  57. <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>
    58. 

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

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

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

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

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

  63. <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>
    64. 

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

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

  66. </ul>
    67. 

  67. 

  68.         </div>
    69. 

  69.       </div>
    70. 

  70.     </nav>
    71. 

  71. 

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

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

  74.           <a href="index.html">SuperGradients</a>
    75. 

  75.       </nav>
    76. 

  76. 

  77.       <div class="wy-nav-content">
    78. 

  78.         <div class="rst-content">
    79. 

  79.           <div role="navigation" aria-label="Page navigation">
    80. 

  80.   <ul class="wy-breadcrumbs">
    81. 

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

  82.       <li>Common package</li>
    83. 

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

  84.             <a href="_sources/super_gradients.common.rst.txt" rel="nofollow"> View page source</a>
    85. 

  85.       </li>
    86. 

  86.   </ul>
    87. 

  87.   <hr/>
    88. 

  88. </div>
    89. 

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

  90.            <div itemprop="articleBody">
    91. 

  91.              
    92. 

  92.   <section id="common-package">
    93. 

  93. <h1>Common package<a class="headerlink" href="#common-package" title="Permalink to this headline"></a></h1>
    94. 

  94. <table class="longtable docutils align-default">
    95. 

  95. <colgroup>
    96. 

  96. <col style="width: 10%" />
    97. 

  97. <col style="width: 90%" />
    98. 

  98. </colgroup>
    99. 

  99. <tbody>
    100. 

  100. </tbody>
    101. 

  101. </table>
    102. 

  102. <span class="target" id="module-super_gradients.common"></span><dl class="py function">
    103. 

  103. <dt class="sig sig-object py" id="super_gradients.common.explicit_params_validation">
    104. 

  104. <span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">explicit_params_validation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validation_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'None'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/decorators/explicit_params_validator.html#explicit_params_validation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.explicit_params_validation" title="Permalink to this definition"></a></dt>
    105. 

  105. <dd></dd></dl>
    106. 

  106. 

  107. <dl class="py function">
    108. 

  108. <dt class="sig sig-object py" id="super_gradients.common.singleton">
    109. 

  109. <span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">singleton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/decorators/singleton.html#singleton"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.singleton" title="Permalink to this definition"></a></dt>
    110. 

  110. <dd><p>A singleton decorator. Returns a wrapper objects. A call on that object
    111. 

  111. returns a single instance object of decorated class. Use the __wrapped__
    112. 

  112. attribute to access decorated class directly in unit tests</p>
    113. 

  113. </dd></dl>
    114. 

  114. 

  115. <dl class="py class">
    116. 

  116. <dt class="sig sig-object py" id="super_gradients.common.AWSConnector">
    117. 

  117. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">AWSConnector</span></span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector" title="Permalink to this definition"></a></dt>
    118. 

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

  119. <p>AWSConnector - Connects to AWS using Credentials File or IAM Role</p>
    120. 

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

  121. <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_session">
    122. 

  122. <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">boto3.session.Session</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.get_aws_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector.get_aws_session" title="Permalink to this definition"></a></dt>
    123. 

  123. <dd><dl class="simple">
    124. 

  124. <dt>get_aws_session - Connects to AWS to retrieve an AWS Session</dt><dd><dl class="field-list simple">
    125. 

  125. <dt class="field-odd">param      profile_name</dt>
    126. 

  126. <dd class="field-odd"><p>The Config Profile (Environment Name in Credentials file)</p>
    127. 

  127. </dd>
    128. 

  128. <dt class="field-even">return</dt>
    129. 

  129. <dd class="field-even"><p>boto3 Session</p>
    130. 

  130. </dd>
    131. 

  131. </dl>
    132. 

  132. </dd>
    133. 

  133. </dl>
    134. 

  134. </dd></dl>
    135. 

  135. 

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

  137. <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_client_for_service_name">
    138. 

  138. <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_client_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">boto3.session.Session.client</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.get_aws_client_for_service_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector.get_aws_client_for_service_name" title="Permalink to this definition"></a></dt>
    139. 

  139. <dd><dl class="simple">
    140. 

  140. <dt>get_aws_client_for_service_name - Connects to AWS to retrieve the relevant Client</dt><dd><dl class="field-list simple">
    141. 

  141. <dt class="field-odd">param      profile_name</dt>
    142. 

  142. <dd class="field-odd"><p>The Config Profile (Environment Name in Credentials file)</p>
    143. 

  143. </dd>
    144. 

  144. <dt class="field-even">param      service_name</dt>
    145. 

  145. <dd class="field-even"><p>The AWS Service name to get the Client for</p>
    146. 

  146. </dd>
    147. 

  147. <dt class="field-odd">return</dt>
    148. 

  148. <dd class="field-odd"><p>Service client instance</p>
    149. 

  149. </dd>
    150. 

  150. </dl>
    151. 

  151. </dd>
    152. 

  152. </dl>
    153. 

  153. </dd></dl>
    154. 

  154. 

  155. <dl class="py method">
    156. 

  156. <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_resource_for_service_name">
    157. 

  157. <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_resource_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">boto3.session.Session.resource</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.get_aws_resource_for_service_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector.get_aws_resource_for_service_name" title="Permalink to this definition"></a></dt>
    158. 

  158. <dd><dl class="simple">
    159. 

  159. <dt>Connects to AWS to retrieve the relevant Resource (More functionality then Client)</dt><dd><dl class="field-list simple">
    160. 

  160. <dt class="field-odd">param      profile_name</dt>
    161. 

  161. <dd class="field-odd"><p>The Config Profile (Environment Name in Credentials file)</p>
    162. 

  162. </dd>
    163. 

  163. <dt class="field-even">param      service_name</dt>
    164. 

  164. <dd class="field-even"><p>The AWS Service name to get the Client for</p>
    165. 

  165. </dd>
    166. 

  166. <dt class="field-odd">return</dt>
    167. 

  167. <dd class="field-odd"><p>Service client instance</p>
    168. 

  168. </dd>
    169. 

  169. </dl>
    170. 

  170. </dd>
    171. 

  171. </dl>
    172. 

  172. </dd></dl>
    173. 

  173. 

  174. <dl class="py method">
    175. 

  175. <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.is_client_error">
    176. 

  176. <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">is_client_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.is_client_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector.is_client_error" title="Permalink to this definition"></a></dt>
    177. 

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

  178. 

  179. </dd></dl>
    180. 

  180. 

  181. <dl class="py class">
    182. 

  182. <dt class="sig sig-object py" id="super_gradients.common.DatasetDataInterface">
    183. 

  183. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">DatasetDataInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_connection_source</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'s3'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_interface/dataset_data_interface.html#DatasetDataInterface"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.DatasetDataInterface" title="Permalink to this definition"></a></dt>
    184. 

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

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

  186. <dt class="sig sig-object py" id="super_gradients.common.DatasetDataInterface.load_remote_dataset_file">
    187. 

  187. <span class="sig-name descname"><span class="pre">load_remote_dataset_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.DatasetDataInterface.load_remote_dataset_file" title="Permalink to this definition"></a></dt>
    188. 

  188. <dd></dd></dl>
    189. 

  189. 

  190. </dd></dl>
    191. 

  191. 

  192. <dl class="py class">
    193. 

  193. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces">
    194. 

  194. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">ADNNModelRepositoryDataInterfaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_connection_location</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">'local'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_connection_credentials</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_interface/adnn_model_repository_data_interface.html#ADNNModelRepositoryDataInterfaces"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces" title="Permalink to this definition"></a></dt>
    195. 

  195. <dd><p>Bases: <a class="reference internal" href="super_gradients.common.abstractions.html#super_gradients.common.abstractions.abstract_logger.ILogger" title="super_gradients.common.abstractions.abstract_logger.ILogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.common.abstractions.abstract_logger.ILogger</span></code></a></p>
    196. 

  196. <p>ResearchModelRepositoryDataInterface</p>
    197. 

  197. <dl class="py method">
    198. 

  198. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files">
    199. 

  199. <span class="sig-name descname"><span class="pre">load_all_remote_log_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files" title="Permalink to this definition"></a></dt>
    200. 

  200. <dd></dd></dl>
    201. 

  201. 

  202. <dl class="py method">
    203. 

  203. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files">
    204. 

  204. <span class="sig-name descname"><span class="pre">save_all_remote_checkpoint_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files" title="Permalink to this definition"></a></dt>
    205. 

  205. <dd></dd></dl>
    206. 

  206. 

  207. <dl class="py method">
    208. 

  208. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file">
    209. 

  209. <span class="sig-name descname"><span class="pre">load_remote_checkpoints_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file" title="Permalink to this definition"></a></dt>
    210. 

  210. <dd></dd></dl>
    211. 

  211. 

  212. <dl class="py method">
    213. 

  213. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_logging_files">
    214. 

  214. <span class="sig-name descname"><span class="pre">load_remote_logging_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_logging_files" title="Permalink to this definition"></a></dt>
    215. 

  215. <dd></dd></dl>
    216. 

  216. 

  217. <dl class="py method">
    218. 

  218. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file">
    219. 

  219. <span class="sig-name descname"><span class="pre">save_remote_checkpoints_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file" title="Permalink to this definition"></a></dt>
    220. 

  220. <dd></dd></dl>
    221. 

  221. 

  222. <dl class="py method">
    223. 

  223. <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files">
    224. 

  224. <span class="sig-name descname"><span class="pre">save_remote_tensorboard_event_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files" title="Permalink to this definition"></a></dt>
    225. 

  225. <dd></dd></dl>
    226. 

  226. 

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

  228. 

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

  230. <dt class="sig sig-object py" id="super_gradients.common.S3Connector">
    231. 

  231. <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">S3Connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bucket_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_connection/s3_connector.html#S3Connector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.S3Connector" title="Permalink to this definition"></a></dt>
    232. 

  232. <dd><p>Bases: <a class="reference internal" href="super_gradients.common.abstractions.html#super_gradients.common.abstractions.abstract_logger.ILogger" title="super_gradients.common.abstractions.abstract_logger.ILogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.common.abstractions.abstract_logger.ILogger</span></code></a></p>
    233. 

  233. <p>S3Connector - S3 Connection Manager</p>
    234. 

  234. <dl class="py method">
    235. 

  235. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.check_key_exists">
    236. 

  236. <span class="sig-name descname"><span class="pre">check_key_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.check_key_exists" title="Permalink to this definition"></a></dt>
    237. 

  237. <dd></dd></dl>
    238. 

  238. 

  239. <dl class="py method">
    240. 

  240. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.get_object_by_etag">
    241. 

  241. <span class="sig-name descname"><span class="pre">get_object_by_etag</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.get_object_by_etag" title="Permalink to this definition"></a></dt>
    242. 

  242. <dd></dd></dl>
    243. 

  243. 

  244. <dl class="py method">
    245. 

  245. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.create_bucket">
    246. 

  246. <span class="sig-name descname"><span class="pre">create_bucket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.create_bucket" title="Permalink to this definition"></a></dt>
    247. 

  247. <dd></dd></dl>
    248. 

  248. 

  249. <dl class="py method">
    250. 

  250. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.delete_bucket">
    251. 

  251. <span class="sig-name descname"><span class="pre">delete_bucket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.delete_bucket" title="Permalink to this definition"></a></dt>
    252. 

  252. <dd></dd></dl>
    253. 

  253. 

  254. <dl class="py method">
    255. 

  255. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.get_object_metadata">
    256. 

  256. <span class="sig-name descname"><span class="pre">get_object_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.get_object_metadata" title="Permalink to this definition"></a></dt>
    257. 

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

  258. 

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

  260. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.delete_key">
    261. 

  261. <span class="sig-name descname"><span class="pre">delete_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.delete_key" title="Permalink to this definition"></a></dt>
    262. 

  262. <dd></dd></dl>
    263. 

  263. 

  264. <dl class="py method">
    265. 

  265. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.upload_file_from_stream">
    266. 

  266. <span class="sig-name descname"><span class="pre">upload_file_from_stream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.upload_file_from_stream" title="Permalink to this definition"></a></dt>
    267. 

  267. <dd></dd></dl>
    268. 

  268. 

  269. <dl class="py method">
    270. 

  270. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.upload_file">
    271. 

  271. <span class="sig-name descname"><span class="pre">upload_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.upload_file" title="Permalink to this definition"></a></dt>
    272. 

  272. <dd></dd></dl>
    273. 

  273. 

  274. <dl class="py method">
    275. 

  275. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.download_key">
    276. 

  276. <span class="sig-name descname"><span class="pre">download_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.download_key" title="Permalink to this definition"></a></dt>
    277. 

  277. <dd></dd></dl>
    278. 

  278. 

  279. <dl class="py method">
    280. 

  280. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.download_keys_by_prefix">
    281. 

  281. <span class="sig-name descname"><span class="pre">download_keys_by_prefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.download_keys_by_prefix" title="Permalink to this definition"></a></dt>
    282. 

  282. <dd></dd></dl>
    283. 

  283. 

  284. <dl class="py method">
    285. 

  285. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.download_file_by_path">
    286. 

  286. <span class="sig-name descname"><span class="pre">download_file_by_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.download_file_by_path" title="Permalink to this definition"></a></dt>
    287. 

  287. <dd></dd></dl>
    288. 

  288. 

  289. <dl class="py method">
    290. 

  290. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.empty_folder_content_by_path_prefix">
    291. 

  291. <span class="sig-name descname"><span class="pre">empty_folder_content_by_path_prefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.empty_folder_content_by_path_prefix" title="Permalink to this definition"></a></dt>
    292. 

  292. <dd></dd></dl>
    293. 

  293. 

  294. <dl class="py method">
    295. 

  295. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.upload_buffer">
    296. 

  296. <span class="sig-name descname"><span class="pre">upload_buffer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.upload_buffer" title="Permalink to this definition"></a></dt>
    297. 

  297. <dd></dd></dl>
    298. 

  298. 

  299. <dl class="py method">
    300. 

  300. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.list_bucket_objects">
    301. 

  301. <span class="sig-name descname"><span class="pre">list_bucket_objects</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.list_bucket_objects" title="Permalink to this definition"></a></dt>
    302. 

  302. <dd></dd></dl>
    303. 

  303. 

  304. <dl class="py method">
    305. 

  305. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.create_presigned_upload_url">
    306. 

  306. <span class="sig-name descname"><span class="pre">create_presigned_upload_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.create_presigned_upload_url" title="Permalink to this definition"></a></dt>
    307. 

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

  308. 

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

  310. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.create_presigned_download_url">
    311. 

  311. <span class="sig-name descname"><span class="pre">create_presigned_download_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.create_presigned_download_url" title="Permalink to this definition"></a></dt>
    312. 

  312. <dd></dd></dl>
    313. 

  313. 

  314. <dl class="py method">
    315. 

  315. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.convert_content_length_to_mb">
    316. 

  316. <em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">convert_content_length_to_mb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_connection/s3_connector.html#S3Connector.convert_content_length_to_mb"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.S3Connector.convert_content_length_to_mb" title="Permalink to this definition"></a></dt>
    317. 

  317. <dd></dd></dl>
    318. 

  318. 

  319. <dl class="py method">
    320. 

  320. <dt class="sig sig-object py" id="super_gradients.common.S3Connector.copy_key">
    321. 

  321. <span class="sig-name descname"><span class="pre">copy_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.S3Connector.copy_key" title="Permalink to this definition"></a></dt>
    322. 

  322. <dd></dd></dl>
    323. 

  323. 

  324. </dd></dl>
    325. 

  325. 

  326. <dl class="py function">
    327. 

  327. <dt class="sig sig-object py" id="super_gradients.common.init_trainer">
    328. 

  328. <span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">init_trainer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/environment/env_helpers.html#init_trainer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.init_trainer" title="Permalink to this definition"></a></dt>
    329. 

  329. <dd><p>a function to initialize the super_gradients environment. This function should be the first thing to be called
    330. 

  330. by any code running super_gradients. It resolves conflicts between the different tools, packages and environments used
    331. 

  331. and prepares the super_gradients environment.</p>
    332. 

  332. </dd></dl>
    333. 

  333. 

  334. <dl class="py function">
    335. 

  335. <dt class="sig sig-object py" id="super_gradients.common.is_distributed">
    336. 

  336. <span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">is_distributed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="pre">bool</span><a class="reference internal" href="_modules/super_gradients/common/environment/env_helpers.html#is_distributed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.is_distributed" title="Permalink to this definition"></a></dt>
    337. 

  337. <dd></dd></dl>
    338. 

  338. 

  339. <section id="module-contents">
    340. 

  340. <h2>Module contents<a class="headerlink" href="#module-contents" title="Permalink to this headline"></a></h2>
    341. 

  341. </section>
    342. 

  342. </section>
    343. 

  343. 

  344. 

  345.            </div>
    346. 

  346.           </div>
    347. 

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

  348.         <a href="super_gradients.training.html" class="btn btn-neutral float-right" title="Training package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    349. 

  349.     </div>
    350. 

  350. 

  351.   <hr/>
    352. 

  352. 

  353.   <div role="contentinfo">
    354. 

  354.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    355. 

  355.   </div>
    356. 

  356. 

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

  358.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    359. 

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

  360.    
    361. 

  361. 

  362. </footer>
    363. 

  363.         </div>
    364. 

  364.       </div>
    365. 

  365.     </section>
    366. 

  366.   </div>
    367. 

  367.   <script>
    368. 

  368.       jQuery(function () {
    369. 

  369.           SphinxRtdTheme.Navigation.enable(true);
    370. 

  370.       });
    371. 

  371.   </script> 
    372. 

  372. 

  373. </body>
    374. 

  374. </html>
    375.
Discard
Prev
Next
Tip!

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