#378 Feature/sg 281 add kd notebook

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:feature/SG-281-add_kd_notebook
  
    
        
          
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

          
            <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>super_gradients.common.decorators.deci_logger &mdash; SuperGradients 1.0 documentation</title>
      <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="../../../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
        <script src="../../../../_static/jquery.js"></script>
        <script src="../../../../_static/underscore.js"></script>
        <script src="../../../../_static/doctools.js"></script>
    <script src="../../../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../search.html" /> 
</head>
<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="../../../../index.html" class="icon icon-home"> SuperGradients
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption"><span class="caption-text">Welcome To SuperGradients</span></p>
<ul>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#supergradients">SuperGradients</a></li>
</ul>
<p class="caption"><span class="caption-text">Technical Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.common.html">Common package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.training.html">Training package</a></li>
</ul>
<p class="caption"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html">What is SuperGradients?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#introducing-the-supergradients-library">Introducing the SuperGradients library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#installation">Installation</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#training-parameters">Training Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#logs-and-checkpoints">Logs and Checkpoints</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#dataset-parameters">Dataset Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#network-architectures">Network Architectures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#pretrained-models">Pretrained Models</a></li>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#professional-tools-integration">Professional Tools Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../user_guide.html#supergradients-faq">SuperGradients FAQ</a></li>
</ul>
        </div>
      </div>
    </nav>
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../../index.html">SuperGradients</a>
      </nav>
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="../../../index.html">Module code</a> &raquo;</li>
      <li>super_gradients.common.decorators.deci_logger</li>
      <li class="wy-breadcrumbs-aside">
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <h1>Source code for super_gradients.common.decorators.deci_logger</h1><div class="highlight"><pre>
<div class="viewcode-block" id="deci_func_logger"><a class="viewcode-back" href="../../../../super_gradients.common.decorators.html#super_gradients.common.decorators.deci_logger.deci_func_logger">[docs]</a><span></span><span class="k">def</span> <span class="nf">deci_func_logger</span><span class="p">(</span><span class="n">_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;abstract_decorator&#39;</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This decorator is used to wrap our functions with logs.</span>
<span class="sd">    It will log every enter and exit of the functon with the equivalent parameters as extras.</span>
<span class="sd">    It will also log exceptions that raises in the function.</span>
<span class="sd">    It will also log the exception time of the function.</span>
<span class="sd">    How it works:`</span>
<span class="sd">        First it will check if the decorator called with name keyword.</span>
<span class="sd">        If so it will return a new decorator that its logger is the name parameter.</span>
<span class="sd">        If not it will return a new decorator that its logger is the wrapped function name.</span>
<span class="sd">        Then the return decorator will return a new function that warps the original function with the new logs.</span>
<span class="sd">        For further understanding advise real-python &quot;fancy decorators documentation&quot;</span>
<span class="sd">    Args:</span>
<span class="sd">        _func (): used when called without name specify. dont pass it directly</span>
<span class="sd">        name (): The name of the logger to save logs by.</span>
<span class="sd">    Returns:</span>
<span class="sd">        a decorator that wraps function with logs logic.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="c1"># TODO: Not Working - Breaks the code, tests does not pass (s3 connector, platform...)</span>
    <span class="c1"># TODO: Fix problem with ExplicitParamValidation error (arguments not passed)</span>
    <span class="c1"># TODO: Run ALL test suite of deci2 (NOT circieCI test suite, but ALL the tests under tests folders)</span>
    <span class="c1"># TODO: Delete/Update all failing tests.</span>
    <span class="c1"># def deci_logger_decorator(fn):</span>
    <span class="c1">#</span>
    <span class="c1"># @functools.wraps(fn)</span>
    <span class="c1"># def wrapper_func(*args, **kwargs):</span>
    <span class="c1">#     try:</span>
    <span class="c1">#</span>
    <span class="c1">#         try:</span>
    <span class="c1">#             logger.debug(f&quot;Start: {fn.__name__}&quot;, extra={&quot;args&quot;: args, &quot;kwargs&quot;: kwargs})</span>
    <span class="c1">#             time1 = time.perf_counter()</span>
    <span class="c1">#         except Exception:</span>
    <span class="c1">#             # failed to write log - continue.</span>
    <span class="c1">#             pass</span>
    <span class="c1">#</span>
    <span class="c1">#         result = fn(*args, **kwargs)</span>
    <span class="c1">#</span>
    <span class="c1">#         try:</span>
    <span class="c1">#             time2 = time.perf_counter()</span>
    <span class="c1">#             logger.debug(f&quot;End: {fn.__name__}&quot;,</span>
    <span class="c1">#                          extra={&#39;duration&#39;: (time2 - time1) * 1000.0, &#39;return_value&#39;: result})</span>
    <span class="c1">#         except Exception:</span>
    <span class="c1">#             # failed to write log - continue.</span>
    <span class="c1">#             pass</span>
    <span class="c1">#</span>
    <span class="c1">#         return result</span>
    <span class="c1">#</span>
    <span class="c1">#     except Exception as ex:</span>
    <span class="c1">#         # This exception was raised from inside the function call</span>
    <span class="c1">#         logger.error(f&quot;Exception: {ex}&quot;, exc_info=ex)</span>
    <span class="c1">#         raise ex</span>
    <span class="c1">#</span>
    <span class="c1"># return wrapper_func</span>
    <span class="c1"># if _func is None:</span>
    <span class="c1">#     logger = get_logger(name)</span>
    <span class="c1">#     return deci_logger_decorator</span>
    <span class="c1"># else:</span>
    <span class="c1">#     logger = get_logger(_func.__name__)</span>
    <span class="c1">#     return deci_logger_decorator(_func)</span>
    <span class="k">return</span> <span class="n">_func</span></div>
<div class="viewcode-block" id="deci_class_logger"><a class="viewcode-back" href="../../../../super_gradients.common.decorators.html#super_gradients.common.decorators.deci_logger.deci_class_logger">[docs]</a><span class="k">def</span> <span class="nf">deci_class_logger</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    This decorator wraps every class method with deci_func_logger decorator.</span>
<span class="sd">    It works by checking if class method is callable and if so it will set a new decorated method as the same method name.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
        <span class="c1"># TODO: Not Working - Breaks the code, tests does not pass (s3 connector, platform...)</span>
        <span class="c1"># TODO: Fix problem with ExplicitParamValidation error (arguments not passed)</span>
        <span class="c1"># TODO: Run ALL test suite of deci2 (NOT circieCI test suite, but ALL the tests under tests folders)</span>
        <span class="c1"># TODO: Delete/Update all failing tests.</span>
        <span class="c1"># for attr in cls.__dict__:</span>
        <span class="c1">#     if callable(getattr(cls, attr)) and attr != &#39;__init__&#39;:</span>
        <span class="c1">#         decorated_function = deci_func_logger(name=cls.__name__)(getattr(cls, attr))</span>
        <span class="c1">#         if type(cls.__dict__[attr]) is staticmethod:</span>
        <span class="c1">#             decorated_function = staticmethod(decorated_function)</span>
        <span class="c1">#         setattr(cls, attr, decorated_function)</span>
        <span class="k">return</span> <span class="bp">cls</span>
    <span class="k">return</span> <span class="n">wrapper</span></div>
</pre></div>
           </div>
          </div>
          <footer>
  <hr/>
  <div role="contentinfo">
    <p>&#169; Copyright 2021, SuperGradients team.</p>
  </div>
  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   
</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 
</body>
</html>

          
        
      

  
Tip!
Press p or to see the previous file or, n or to see the next file
Deci-AI / super-gradients connected to https://github.com/Deci-AI/super-gradients.git

#378 Feature/sg 281 add kd notebook

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