#288 Add linter (flake8) check in CI

Merged
GitHub User merged 1 commits into Deci-AI:master from deci-ai:feature/SG-79-add-flake_8_linter
  
    
        
          
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

          
            <!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>Welcome to SuperGradients’s documentation! &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="#" 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#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="#">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="#" class="icon icon-home"></a> &raquo;</li>
      <li>Welcome to SuperGradients’s documentation!</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/index.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="welcome-to-supergradients-s-documentation">
<h1>Welcome to SuperGradients’s documentation!<a class="headerlink" href="#welcome-to-supergradients-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Welcome To SuperGradients</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="welcome.html#supergradients">SuperGradients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#introduction">Introduction</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#why-use-supergradients">Why use SuperGradients?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#what-s-new">What’s New</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#comming-soon">Comming soon</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#table-of-content">Table of Content</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#getting-started">Getting Started</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#start-training-with-just-1-command-line">Start Training with Just 1 Command Line</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#quickly-load-pre-trained-weights-for-your-desired-model-with-sota-performance">Quickly Load Pre-Trained Weights for Your Desired Model with SOTA Performance</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#quick-start-notebook-classification">Quick Start Notebook - Classification</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#quick-start-notebook-object-detection">Quick Start Notebook - Object Detection</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#quick-start-notebook-semantic-segmentation">Quick Start Notebook - Semantic Segmentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#supergradients-complete-walkthrough-notebook">SuperGradients Complete Walkthrough Notebook</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#transfer-learning">Transfer Learning</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#transfer-learning-with-sg-notebook-object-detection">Transfer Learning with SG Notebook - Object Detection</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#transfer-learning-with-sg-notebook-semantic-segmentation">Transfer Learning with SG Notebook - Semantic Segmentation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#installation-methods">Installation Methods</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#quick-installation">Quick Installation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#computer-vision-models-pretrained-checkpoints">Computer Vision Models - Pretrained Checkpoints</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#pretrained-classification-pytorch-checkpoints">Pretrained Classification PyTorch Checkpoints</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#pretrained-object-detection-pytorch-checkpoints">Pretrained Object Detection PyTorch Checkpoints</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#pretrained-semantic-segmentation-pytorch-checkpoints">Pretrained Semantic Segmentation PyTorch Checkpoints</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#implemented-model-architectures">Implemented Model Architectures</a><ul>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#image-classification">Image Classification</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#object-detection">Object Detection</a></li>
<li class="toctree-l3"><a class="reference internal" href="welcome.html#semantic-segmentation">Semantic Segmentation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#contributing">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#citation">Citation</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#community">Community</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="welcome.html#deci-platform">Deci Platform</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.common.html#module-contents">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="super_gradients.training.html">Training package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training">super_gradients.training module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#super-gradients-training-datasets-module">super_gradients.training.datasets module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#super-gradients-training-exceptions-module">super_gradients.training.exceptions module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.legacy">super_gradients.training.legacy module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.losses">super_gradients.training.losses_models module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.metrics">super_gradients.training.metrics module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.models">super_gradients.training.models module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.sg_model">super_gradients.training.sg_model module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-super_gradients.training.utils">super_gradients.training.utils module</a></li>
<li class="toctree-l2"><a class="reference internal" href="super_gradients.training.html#module-contents">Module contents</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-main-components">Integrating Your Training Code: Main components:</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough-dataset">Integrating Your Training Code - Complete Walkthrough: Dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough-model">Integrating Your Training Code - Complete Walkthrough: Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough-loss-function">Integrating Your Training Code - Complete Walkthrough: Loss Function</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough-metrics">Integrating Your Training Code - Complete Walkthrough: Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough-training-script">Integrating Your Training Code- Complete Walkthrough: Training script</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide.html#training-parameter-notes">Training Parameter Notes:</a></li>
</ul>
</li>
</ul>
</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><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#weights-and-biases">Weights and Biases</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_guide.html#setting-up-the-environment">Setting-up the environment</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html#supergradients-faq">SuperGradients FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#what-type-of-tasks-does-the-supergradients-support">What Type of Tasks Does the SuperGradients Support?</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
           </div>
          </div>
  <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

#288 Add linter (flake8) check in CI

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