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


  
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

	
            <!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>super_gradients.common.auto_logging package &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" />
  <!--[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">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="super_gradients.training.html">super_gradients.training package</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>super_gradients.common.auto_logging package</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/super_gradients.common.auto_logging.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="super-gradients-common-auto-logging-package">
<h1>super_gradients.common.auto_logging package<a class="headerlink" href="#super-gradients-common-auto-logging-package" title="Permalink to this headline"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-super_gradients.common.auto_logging.auto_logger">
<span id="super-gradients-common-auto-logging-auto-logger-module"></span><h2>super_gradients.common.auto_logging.auto_logger module<a class="headerlink" href="#module-super_gradients.common.auto_logging.auto_logger" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.auto_logging.auto_logger.</span></span><span class="sig-name descname"><span class="pre">AutoLoggerConfig</span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A Class for the Automated Logging Config that is created from the JSON config file (auto_logging_conf)</p>
<dl class="py method">
<dt class="sig sig-object py" id="super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig.configure_elasticsearch_handler">
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">configure_elasticsearch_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_dict</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_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/auto_logging/auto_logger.html#AutoLoggerConfig.configure_elasticsearch_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig.configure_elasticsearch_handler" title="Permalink to this definition"></a></dt>
<dd><p>Configures the ElasticSearch loggeing handler through an matching library.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig.generate_config_for_module_name">
<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">generate_config_for_module_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">training_log_path</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">log_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'INFO'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_bytes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10485760</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs_dir_path</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">handlers_list</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> &#x2192; <span class="pre">dict</span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig.generate_config_for_module_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.auto_logger.AutoLoggerConfig.generate_config_for_module_name" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>generate_config_for_module_name - Returns a Config Dict For Logging</dt><dd><dl class="field-list simple">
<dt class="field-odd">param module_name</dt>
<dd class="field-odd"><p>The Python Module name to create auto_logging for</p>
</dd>
<dt class="field-even">param log_level</dt>
<dd class="field-even"><p>Minimal log level to set for the new auto_logging</p>
</dd>
<dt class="field-odd">param max_bytes</dt>
<dd class="field-odd"><p>Max size for the log file before rotation starts</p>
</dd>
<dt class="field-even">param handlers_list</dt>
<dd class="field-even"><p>A list specifying the handlers (Console, etc..) - Better Leave Empty or None</p>
</dd>
<dt class="field-odd">param training_log_path</dt>
<dd class="field-odd"><p>Path to training log file which all modules of super_gradients will write to. Ignored
when set to None.</p>
</dd>
<dt class="field-even">param logs_dir_path</dt>
<dd class="field-even"><p>Path to sg_logs directory (default=None), where module logs will be saved. When set
to None- module logs will be saved in ~/sg_logs (created if path does not exist). Main use case is for
testing.</p>
</dd>
<dt class="field-odd">return</dt>
<dd class="field-odd"><p>python dict() with the new auto_logging for the module</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>
<section id="module-super_gradients.common.auto_logging">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-super_gradients.common.auto_logging" title="Permalink to this headline"></a></h2>
</section>
</section>


           </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>