Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

#462 fix documentation scripts

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:feature/sg-19_fix_documentation_scripts
55 changed files with 142 additions and 1292 deletions
  1. BIN
      documentation/assets/SG_img/Classification 1500x900.png
  2. BIN
      documentation/assets/SG_img/Classification.png
  3. BIN
      documentation/assets/SG_img/Classification@2x.png
  4. BIN
      documentation/assets/SG_img/Classification@2xDark.png
  5. BIN
      documentation/assets/SG_img/Object Detection.png
  6. BIN
      documentation/assets/SG_img/Object Detection@2x.png
  7. BIN
      documentation/assets/SG_img/Object Detection@2xDark.png
  8. BIN
      documentation/assets/SG_img/Object detection 1500X900.png
  9. BIN
      documentation/assets/SG_img/SG - Horizontal Glow 2.png
  10. BIN
      documentation/assets/SG_img/SG - Horizontal Glow.png
  11. BIN
      documentation/assets/SG_img/SG_sticker.png
  12. BIN
      documentation/assets/SG_img/Segmentation 1500x900 .png
  13. BIN
      documentation/assets/SG_img/Semantic Segmentation.png
  14. BIN
      documentation/assets/SG_img/Semantic Segmentation@2x.png
  15. BIN
      documentation/assets/SG_img/Semantic Segmentation@2xDark.png
  16. BIN
      documentation/assets/SG_img/detection-demo.png
  17. 3
    0
      documentation/source/_static/custom.css
  18. 33
    26
      documentation/source/conf.py
  19. 0
    23
      documentation/source/generated/super_gradients.common.abstractions.rst
  20. 0
    23
      documentation/source/generated/super_gradients.common.auto_logging.rst
  21. 0
    23
      documentation/source/generated/super_gradients.common.aws_connection.rst
  22. 0
    23
      documentation/source/generated/super_gradients.common.data_connection.rst
  23. 0
    23
      documentation/source/generated/super_gradients.common.data_interface.rst
  24. 0
    23
      documentation/source/generated/super_gradients.common.data_types.rst
  25. 0
    23
      documentation/source/generated/super_gradients.common.decorators.rst
  26. 0
    23
      documentation/source/generated/super_gradients.common.environment.rst
  27. 3
    3
      documentation/source/index.rst
  28. 3
    3
      documentation/source/sphinx-requirements.txt
  29. 0
    21
      documentation/source/super_gradients.common.abstractions.rst
  30. 0
    21
      documentation/source/super_gradients.common.auto_logging.rst
  31. 0
    29
      documentation/source/super_gradients.common.aws_connection.rst
  32. 0
    21
      documentation/source/super_gradients.common.data_connection.rst
  33. 0
    29
      documentation/source/super_gradients.common.data_interface.rst
  34. 0
    21
      documentation/source/super_gradients.common.data_types.enum.rst
  35. 0
    18
      documentation/source/super_gradients.common.data_types.rst
  36. 0
    37
      documentation/source/super_gradients.common.decorators.rst
  37. 0
    29
      documentation/source/super_gradients.common.environment.rst
  38. 33
    7
      documentation/source/super_gradients.common.rst
  39. 0
    10
      documentation/source/super_gradients.training.datasets.classification_datasets.rst
  40. 0
    21
      documentation/source/super_gradients.training.datasets.dataset_interfaces.rst
  41. 0
    37
      documentation/source/super_gradients.training.datasets.detection_datasets.rst
  42. 0
    80
      documentation/source/super_gradients.training.datasets.rst
  43. 0
    53
      documentation/source/super_gradients.training.datasets.segmentation_datasets.rst
  44. 0
    29
      documentation/source/super_gradients.training.exceptions.rst
  45. 0
    21
      documentation/source/super_gradients.training.legacy.rst
  46. 0
    101
      documentation/source/super_gradients.training.losses.rst
  47. 0
    45
      documentation/source/super_gradients.training.metrics.rst
  48. 0
    237
      documentation/source/super_gradients.training.models.rst
  49. 37
    3
      documentation/source/super_gradients.training.rst
  50. 0
    21
      documentation/source/super_gradients.training.sg_model.rst
  51. 0
    21
      documentation/source/super_gradients.training.utils.optimizers.rst
  52. 0
    149
      documentation/source/super_gradients.training.utils.rst
  53. 6
    6
      scripts/generate_docs.sh
  54. 17
    3
      src/super_gradients/common/__init__.py
  55. 7
    6
      src/super_gradients/common/data_types/enum/strict_load.py
Discard
Discard
Discard
Discard
Discard
Discard
Discard
Discard
Metadata:
Discard
Metadata:
Discard
Discard
Discard
Discard
Discard
Discard
Discard
1
2
3
  1. .wy-nav-content {
  2. max-width: 1200px !important;
  3. }
Discard
@@ -12,21 +12,25 @@
 #
 #
 import os
 import os
 import sys
 import sys
-sys.path.insert(0, os.path.abspath('../../src'))
+
+# Imports for auto documentation
+import super_gradients
+import super_gradients.common as common
+import super_gradients.training as training
+
+__all__ = ["super_gradients", "common", "training"]
+
+sys.path.insert(0, os.path.abspath("../../src"))
 
 
 # -- Project information -----------------------------------------------------
 # -- Project information -----------------------------------------------------
 
 
-project = 'SuperGradients'
-copyright = '2021, SuperGradients team'
-author = 'SuperGradients team'
+project = "SuperGradients"
+copyright = "2021, SuperGradients team"
+author = "SuperGradients team"
 
 
 # The full version, including alpha/beta/rc tags
 # The full version, including alpha/beta/rc tags
-release = '1.0'
+release = "3.0.2"
 
 
-# Imports for auto documentation
-import super_gradients
-import super_gradients.common
-import super_gradients.training
 
 
 # -- General configuration ---------------------------------------------------
 # -- General configuration ---------------------------------------------------
 
 
@@ -37,18 +41,18 @@ import super_gradients.training
 extensions = []
 extensions = []
 
 
 autodoc_default_options = {
 autodoc_default_options = {
-    'member-order': 'bysource',
+    "member-order": "bysource",
 }
 }
 
 
 # Add any paths that contain templates here, relative to this directory.
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 
 # List of patterns, relative to source directory, that match files and
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 exclude_patterns = []
 
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 todo_include_todos = False
 todo_include_todos = False
 
 
 # -- Options for HTML output -------------------------------------------------
 # -- Options for HTML output -------------------------------------------------
@@ -57,29 +61,32 @@ todo_include_todos = False
 # a list of builtin themes.
 # a list of builtin themes.
 #
 #
 
 
-extensions.append('sphinx.ext.todo')
-extensions.append('sphinx.ext.autodoc')
-extensions.append('sphinx.ext.autosummary')
-extensions.append('sphinx.ext.intersphinx')
-extensions.append('sphinx.ext.mathjax')
-extensions.append('sphinx.ext.viewcode')
-extensions.append('sphinx.ext.graphviz')
-extensions.append('sphinxcontrib.napoleon')
-extensions.append('myst_parser')
+extensions.append("sphinx.ext.todo")
+extensions.append("sphinx.ext.autodoc")
+extensions.append("sphinx.ext.autosummary")
+extensions.append("sphinx.ext.intersphinx")
+extensions.append("sphinx.ext.mathjax")
+extensions.append("sphinx.ext.viewcode")
+extensions.append("sphinx.ext.graphviz")
+extensions.append("sphinxcontrib.napoleon")
+extensions.append("myst_parser")
 
 
 autosummary_generate = True
 autosummary_generate = True
 
 
 # html_theme = 'default'
 # html_theme = 'default'
 # html_theme = 'alabaster'
 # html_theme = 'alabaster'
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
+
+html_css_files = [
+    "custom.css",
+]
 
 
 source_suffix = {
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".md": "markdown",
 }
 }
-
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.abstractions
  2. ====================================
  3. .. automodule:: super_gradients.common.abstractions
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.auto\_logging
  2. =====================================
  3. .. automodule:: super_gradients.common.auto_logging
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.aws\_connection
  2. =======================================
  3. .. automodule:: super_gradients.common.aws_connection
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.data\_connection
  2. ========================================
  3. .. automodule:: super_gradients.common.data_connection
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.data\_interface
  2. =======================================
  3. .. automodule:: super_gradients.common.data_interface
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.data\_types
  2. ===================================
  3. .. automodule:: super_gradients.common.data_types
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.decorators
  2. ==================================
  3. .. automodule:: super_gradients.common.decorators
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  1. super\_gradients.common.environment
  2. ===================================
  3. .. automodule:: super_gradients.common.environment
Discard
@@ -20,10 +20,10 @@ Welcome to SuperGradients's documentation!
    super_gradients.training
    super_gradients.training
 
 
 .. toctree::
 .. toctree::
-   :maxdepth: 4
-   :caption: User Guide
+.. :maxdepth: 4
+.. :caption: User Guide
 
 
-   user_guide
+.. user_guide
 
 
 Indices and tables
 Indices and tables
 ==================
 ==================
Discard
@@ -1,3 +1,3 @@
-sphinx
-sphinxcontrib-napoleon
-myst-parser
+Sphinx==5.3.0
+sphinxcontrib.napoleon
+myst-parser
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.common.abstractions package
  2. ============================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.abstractions.abstract\_logger module
  6. ------------------------------------------------------------
  7. .. automodule:: super_gradients.common.abstractions.abstract_logger
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.common.abstractions
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.common.auto\_logging package
  2. =============================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.auto\_logging.auto\_logger module
  6. ---------------------------------------------------------
  7. .. automodule:: super_gradients.common.auto_logging.auto_logger
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.common.auto_logging
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
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
  1. super\_gradients.common.aws\_connection package
  2. ===============================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.aws\_connection.aws\_connector module
  6. -------------------------------------------------------------
  7. .. automodule:: super_gradients.common.aws_connection.aws_connector
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.common.aws\_connection.aws\_secrets\_manager\_connector module
  12. -------------------------------------------------------------------------------
  13. .. automodule:: super_gradients.common.aws_connection.aws_secrets_manager_connector
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. Module contents
  18. ---------------
  19. .. automodule:: super_gradients.common.aws_connection
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.common.data\_connection package
  2. ================================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.data\_connection.s3\_connector module
  6. -------------------------------------------------------------
  7. .. automodule:: super_gradients.common.data_connection.s3_connector
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.common.data_connection
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
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
  1. super\_gradients.common.data\_interface package
  2. ===============================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.data\_interface.adnn\_model\_repository\_data\_interface module
  6. ---------------------------------------------------------------------------------------
  7. .. automodule:: super_gradients.common.data_interface.adnn_model_repository_data_interface
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.common.data\_interface.dataset\_data\_interface module
  12. -----------------------------------------------------------------------
  13. .. automodule:: super_gradients.common.data_interface.dataset_data_interface
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. Module contents
  18. ---------------
  19. .. automodule:: super_gradients.common.data_interface
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.common.data\_types.enum package
  2. ================================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.data\_types.enum.deep\_learning\_task module
  6. --------------------------------------------------------------------
  7. .. automodule:: super_gradients.common.data_types.enum.deep_learning_task
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.common.data_types.enum
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
  1. super\_gradients.common.data\_types package
  2. ===========================================
  3. Subpackages
  4. -----------
  5. .. toctree::
  6. :maxdepth: 4
  7. super_gradients.common.data_types.enum
  8. Module contents
  9. ---------------
  10. .. automodule:: super_gradients.common.data_types
  11. :members:
  12. :undoc-members:
  13. :show-inheritance:
Discard
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
  1. super\_gradients.common.decorators package
  2. ==========================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.decorators.deci\_logger module
  6. ------------------------------------------------------
  7. .. automodule:: super_gradients.common.decorators.deci_logger
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.common.decorators.explicit\_params\_validator module
  12. ---------------------------------------------------------------------
  13. .. automodule:: super_gradients.common.decorators.explicit_params_validator
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.common.decorators.singleton module
  18. ---------------------------------------------------
  19. .. automodule:: super_gradients.common.decorators.singleton
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. Module contents
  24. ---------------
  25. .. automodule:: super_gradients.common.decorators
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
Discard
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
  1. super\_gradients.common.environment package
  2. ===========================================
  3. Submodules
  4. ----------
  5. super\_gradients.common.environment.env\_helpers module
  6. -------------------------------------------------------
  7. .. automodule:: super_gradients.common.environment.env_helpers
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.common.environment.environment\_config module
  12. --------------------------------------------------------------
  13. .. automodule:: super_gradients.common.environment.environment_config
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. Module contents
  18. ---------------
  19. .. automodule:: super_gradients.common.environment
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
Discard
@@ -9,35 +9,61 @@ Common package
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.auto_logging
+.. automodule:: super_gradients.common.auto_logging
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.aws_connection
+.. automodule:: super_gradients.common.abstraction
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.data_interface
+.. automodule:: super_gradients.common.data_connection
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.data_types
+
+.. automodule:: super_gradients.common.data_interface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: super_gradients.common.data_types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: super_gradients.common.decorators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: super_gradients.common.environment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: super_gradients.common.factories
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: super_gradients.common.plugins
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.decorators
+.. automodule:: super_gradients.common.registry
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
-.. automodule:: super_gradients.environment
+.. automodule:: super_gradients.common.sg_loggers
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
 Module contents
 Module contents
----------------
+---------------
Discard
1
2
3
4
5
6
7
8
9
10
  1. super\_gradients.training.datasets.classification\_datasets package
  2. ===================================================================
  3. Module contents
  4. ---------------
  5. .. automodule:: super_gradients.training.datasets.classification_datasets
  6. :members:
  7. :undoc-members:
  8. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.training.datasets.dataset\_interfaces package
  2. ==============================================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.datasets.dataset\_interfaces.dataset\_interface module
  6. --------------------------------------------------------------------------------
  7. .. automodule:: super_gradients.training.datasets.dataset_interfaces.dataset_interface
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.training.datasets.dataset_interfaces
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
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
  1. super\_gradients.training.datasets.detection\_datasets package
  2. ==============================================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.datasets.detection\_datasets.coco\_detection module
  6. -----------------------------------------------------------------------------
  7. .. automodule:: super_gradients.training.datasets.detection_datasets.coco_detection
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.datasets.detection\_datasets.detection\_dataset module
  12. --------------------------------------------------------------------------------
  13. .. automodule:: super_gradients.training.datasets.detection_datasets.detection_dataset
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.training.datasets.detection\_datasets.pascal\_voc\_detection module
  18. ------------------------------------------------------------------------------------
  19. .. automodule:: super_gradients.training.datasets.detection_datasets.pascal_voc_detection
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. Module contents
  24. ---------------
  25. .. automodule:: super_gradients.training.datasets.detection_datasets
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
Discard
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
  1. super\_gradients.training.datasets package
  2. ==========================================
  3. Subpackages
  4. -----------
  5. .. toctree::
  6. :maxdepth: 4
  7. super_gradients.training.datasets.classification_datasets
  8. super_gradients.training.datasets.dataset_interfaces
  9. super_gradients.training.datasets.detection_datasets
  10. super_gradients.training.datasets.segmentation_datasets
  11. Submodules
  12. ----------
  13. super\_gradients.training.datasets.all\_datasets module
  14. -------------------------------------------------------
  15. .. automodule:: super_gradients.training.datasets.all_datasets
  16. :members:
  17. :undoc-members:
  18. :show-inheritance:
  19. super\_gradients.training.datasets.auto\_augment module
  20. -------------------------------------------------------
  21. .. automodule:: super_gradients.training.datasets.auto_augment
  22. :members:
  23. :undoc-members:
  24. :show-inheritance:
  25. super\_gradients.training.datasets.data\_augmentation module
  26. ------------------------------------------------------------
  27. .. automodule:: super_gradients.training.datasets.data_augmentation
  28. :members:
  29. :undoc-members:
  30. :show-inheritance:
  31. super\_gradients.training.datasets.datasets\_conf module
  32. --------------------------------------------------------
  33. .. automodule:: super_gradients.training.datasets.datasets_conf
  34. :members:
  35. :undoc-members:
  36. :show-inheritance:
  37. super\_gradients.training.datasets.datasets\_utils module
  38. ---------------------------------------------------------
  39. .. automodule:: super_gradients.training.datasets.datasets_utils
  40. :members:
  41. :undoc-members:
  42. :show-inheritance:
  43. super\_gradients.training.datasets.mixup module
  44. -----------------------------------------------
  45. .. automodule:: super_gradients.training.datasets.mixup
  46. :members:
  47. :undoc-members:
  48. :show-inheritance:
  49. super\_gradients.training.datasets.sg\_dataset module
  50. -----------------------------------------------------
  51. .. automodule:: super_gradients.training.datasets.sg_dataset
  52. :members:
  53. :undoc-members:
  54. :show-inheritance:
  55. Module contents
  56. ---------------
  57. .. automodule:: super_gradients.training.datasets
  58. :members:
  59. :undoc-members:
  60. :show-inheritance:
Discard
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
  1. super\_gradients.training.datasets.segmentation\_datasets package
  2. =================================================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.datasets.segmentation\_datasets.cityscape\_segmentation module
  6. ----------------------------------------------------------------------------------------
  7. .. automodule:: super_gradients.training.datasets.segmentation_datasets.cityscape_segmentation
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.datasets.segmentation\_datasets.coco\_segmentation module
  12. -----------------------------------------------------------------------------------
  13. .. automodule:: super_gradients.training.datasets.segmentation_datasets.coco_segmentation
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.training.datasets.segmentation\_datasets.pascal\_aug\_segmentation module
  18. ------------------------------------------------------------------------------------------
  19. .. automodule:: super_gradients.training.datasets.segmentation_datasets.pascal_aug_segmentation
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. super\_gradients.training.datasets.segmentation\_datasets.pascal\_voc\_segmentation module
  24. ------------------------------------------------------------------------------------------
  25. .. automodule:: super_gradients.training.datasets.segmentation_datasets.pascal_voc_segmentation
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
  29. super\_gradients.training.datasets.segmentation\_datasets.segmentation\_dataset module
  30. --------------------------------------------------------------------------------------
  31. .. automodule:: super_gradients.training.datasets.segmentation_datasets.segmentation_dataset
  32. :members:
  33. :undoc-members:
  34. :show-inheritance:
  35. Module contents
  36. ---------------
  37. .. automodule:: super_gradients.training.datasets.segmentation_datasets
  38. :members:
  39. :undoc-members:
  40. :show-inheritance:
Discard
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
  1. super\_gradients.training.exceptions package
  2. ============================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.exceptions.dataset\_exceptions module
  6. ---------------------------------------------------------------
  7. .. automodule:: super_gradients.training.exceptions.dataset_exceptions
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.exceptions.sg\_model\_exceptions module
  12. -----------------------------------------------------------------
  13. .. automodule:: super_gradients.training.exceptions.sg_model_exceptions
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. Module contents
  18. ---------------
  19. .. automodule:: super_gradients.training.exceptions
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.training.legacy package
  2. ========================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.legacy.utils module
  6. ---------------------------------------------
  7. .. automodule:: super_gradients.training.legacy.utils
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.training.legacy
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
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
  1. super\_gradients.training.losses package
  2. ========================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.losses.all\_losses module
  6. ---------------------------------------------------
  7. .. automodule:: super_gradients.training.losses.all_losses
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.losses.ddrnet\_loss module
  12. ----------------------------------------------------
  13. .. automodule:: super_gradients.training.losses.ddrnet_loss
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.training.losses.focal\_loss module
  18. ---------------------------------------------------
  19. .. automodule:: super_gradients.training.losses.focal_loss
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. super\_gradients.training.losses.label\_smoothing\_cross\_entropy\_loss module
  24. ------------------------------------------------------------------------------
  25. .. automodule:: super_gradients.training.losses.label_smoothing_cross_entropy_loss
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
  29. super\_gradients.training.losses.ohem\_ce\_loss module
  30. ------------------------------------------------------
  31. .. automodule:: super_gradients.training.losses.ohem_ce_loss
  32. :members:
  33. :undoc-members:
  34. :show-inheritance:
  35. super\_gradients.training.losses.r\_squared\_loss module
  36. --------------------------------------------------------
  37. .. automodule:: super_gradients.training.losses.r_squared_loss
  38. :members:
  39. :undoc-members:
  40. :show-inheritance:
  41. super\_gradients.training.losses.shelfnet\_ohem\_loss module
  42. ------------------------------------------------------------
  43. .. automodule:: super_gradients.training.losses.shelfnet_ohem_loss
  44. :members:
  45. :undoc-members:
  46. :show-inheritance:
  47. super\_gradients.training.losses.shelfnet\_semantic\_encoding\_loss module
  48. --------------------------------------------------------------------------
  49. .. automodule:: super_gradients.training.losses.shelfnet_semantic_encoding_loss
  50. :members:
  51. :undoc-members:
  52. :show-inheritance:
  53. super\_gradients.training.losses.ssd\_loss module
  54. -------------------------------------------------
  55. .. automodule:: super_gradients.training.losses.ssd_loss
  56. :members:
  57. :undoc-members:
  58. :show-inheritance:
  59. super\_gradients.training.losses.yolo\_v3\_loss module
  60. ------------------------------------------------------
  61. .. automodule:: super_gradients.training.losses.yolo_v3_loss
  62. :members:
  63. :undoc-members:
  64. :show-inheritance:
  65. super\_gradients.training.losses.yolo\_v5\_loss module
  66. ------------------------------------------------------
  67. .. automodule:: super_gradients.training.losses.yolo_v5_loss
  68. :members:
  69. :undoc-members:
  70. :show-inheritance:
  71. Module contents
  72. ---------------
  73. .. automodule:: super_gradients.training.losses
  74. :members:
  75. :undoc-members:
  76. :show-inheritance:
Discard
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
  1. super\_gradients.training.metrics package
  2. =========================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.metrics.classification\_metrics module
  6. ----------------------------------------------------------------
  7. .. automodule:: super_gradients.training.metrics.classification_metrics
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.metrics.detection\_metrics module
  12. -----------------------------------------------------------
  13. .. automodule:: super_gradients.training.metrics.detection_metrics
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.training.metrics.metric\_utils module
  18. ------------------------------------------------------
  19. .. automodule:: super_gradients.training.metrics.metric_utils
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. super\_gradients.training.metrics.segmentation\_metrics module
  24. --------------------------------------------------------------
  25. .. automodule:: super_gradients.training.metrics.segmentation_metrics
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
  29. Module contents
  30. ---------------
  31. .. automodule:: super_gradients.training.metrics
  32. :members:
  33. :undoc-members:
  34. :show-inheritance:
Discard
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
  1. super\_gradients.training.models package
  2. ========================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.models.all\_architectures module
  6. ----------------------------------------------------------
  7. .. automodule:: super_gradients.training.models.all_architectures
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. super\_gradients.training.models.csp\_darknet53 module
  12. ------------------------------------------------------
  13. .. automodule:: super_gradients.training.models.csp_darknet53
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
  17. super\_gradients.training.models.darknet53 module
  18. -------------------------------------------------
  19. .. automodule:: super_gradients.training.models.darknet53
  20. :members:
  21. :undoc-members:
  22. :show-inheritance:
  23. super\_gradients.training.models.ddrnet module
  24. ----------------------------------------------
  25. .. automodule:: super_gradients.training.models.ddrnet
  26. :members:
  27. :undoc-members:
  28. :show-inheritance:
  29. super\_gradients.training.models.densenet module
  30. ------------------------------------------------
  31. .. automodule:: super_gradients.training.models.densenet
  32. :members:
  33. :undoc-members:
  34. :show-inheritance:
  35. super\_gradients.training.models.dpn module
  36. -------------------------------------------
  37. .. automodule:: super_gradients.training.models.dpn
  38. :members:
  39. :undoc-members:
  40. :show-inheritance:
  41. super\_gradients.training.models.efficientnet module
  42. ----------------------------------------------------
  43. .. automodule:: super_gradients.training.models.efficientnet
  44. :members:
  45. :undoc-members:
  46. :show-inheritance:
  47. super\_gradients.training.models.googlenet module
  48. -------------------------------------------------
  49. .. automodule:: super_gradients.training.models.googlenet
  50. :members:
  51. :undoc-members:
  52. :show-inheritance:
  53. super\_gradients.training.models.laddernet module
  54. -------------------------------------------------
  55. .. automodule:: super_gradients.training.models.laddernet
  56. :members:
  57. :undoc-members:
  58. :show-inheritance:
  59. super\_gradients.training.models.lenet module
  60. ---------------------------------------------
  61. .. automodule:: super_gradients.training.models.lenet
  62. :members:
  63. :undoc-members:
  64. :show-inheritance:
  65. super\_gradients.training.models.mobilenet module
  66. -------------------------------------------------
  67. .. automodule:: super_gradients.training.models.mobilenet
  68. :members:
  69. :undoc-members:
  70. :show-inheritance:
  71. super\_gradients.training.models.mobilenetv2 module
  72. ---------------------------------------------------
  73. .. automodule:: super_gradients.training.models.mobilenetv2
  74. :members:
  75. :undoc-members:
  76. :show-inheritance:
  77. super\_gradients.training.models.mobilenetv3 module
  78. ---------------------------------------------------
  79. .. automodule:: super_gradients.training.models.mobilenetv3
  80. :members:
  81. :undoc-members:
  82. :show-inheritance:
  83. super\_gradients.training.models.pnasnet module
  84. -----------------------------------------------
  85. .. automodule:: super_gradients.training.models.pnasnet
  86. :members:
  87. :undoc-members:
  88. :show-inheritance:
  89. super\_gradients.training.models.preact\_resnet module
  90. ------------------------------------------------------
  91. .. automodule:: super_gradients.training.models.preact_resnet
  92. :members:
  93. :undoc-members:
  94. :show-inheritance:
  95. super\_gradients.training.models.regnet module
  96. ----------------------------------------------
  97. .. automodule:: super_gradients.training.models.regnet
  98. :members:
  99. :undoc-members:
  100. :show-inheritance:
  101. super\_gradients.training.models.repvgg module
  102. ----------------------------------------------
  103. .. automodule:: super_gradients.training.models.repvgg
  104. :members:
  105. :undoc-members:
  106. :show-inheritance:
  107. super\_gradients.training.models.resnet module
  108. ----------------------------------------------
  109. .. automodule:: super_gradients.training.models.resnet
  110. :members:
  111. :undoc-members:
  112. :show-inheritance:
  113. super\_gradients.training.models.resnext module
  114. -----------------------------------------------
  115. .. automodule:: super_gradients.training.models.resnext
  116. :members:
  117. :undoc-members:
  118. :show-inheritance:
  119. super\_gradients.training.models.senet module
  120. ---------------------------------------------
  121. .. automodule:: super_gradients.training.models.senet
  122. :members:
  123. :undoc-members:
  124. :show-inheritance:
  125. super\_gradients.training.models.sg\_module module
  126. --------------------------------------------------
  127. .. automodule:: super_gradients.training.models.sg_module
  128. :members:
  129. :undoc-members:
  130. :show-inheritance:
  131. super\_gradients.training.models.shelfnet module
  132. ------------------------------------------------
  133. .. automodule:: super_gradients.training.models.shelfnet
  134. :members:
  135. :undoc-members:
  136. :show-inheritance:
  137. super\_gradients.training.models.shufflenet module
  138. --------------------------------------------------
  139. .. automodule:: super_gradients.training.models.shufflenet
  140. :members:
  141. :undoc-members:
  142. :show-inheritance:
  143. super\_gradients.training.models.shufflenetv2 module
  144. ----------------------------------------------------
  145. .. automodule:: super_gradients.training.models.shufflenetv2
  146. :members:
  147. :undoc-members:
  148. :show-inheritance:
  149. super\_gradients.training.models.ssd module
  150. -------------------------------------------
  151. .. automodule:: super_gradients.training.models.ssd
  152. :members:
  153. :undoc-members:
  154. :show-inheritance:
  155. super\_gradients.training.models.vgg module
  156. -------------------------------------------
  157. .. automodule:: super_gradients.training.models.vgg
  158. :members:
  159. :undoc-members:
  160. :show-inheritance:
  161. super\_gradients.training.models.yolov3 module
  162. ----------------------------------------------
  163. .. automodule:: super_gradients.training.models.yolov3
  164. :members:
  165. :undoc-members:
  166. :show-inheritance:
  167. super\_gradients.training.models.yolov5 module
  168. ----------------------------------------------
  169. .. automodule:: super_gradients.training.models.yolov5
  170. :members:
  171. :undoc-members:
  172. :show-inheritance:
  173. Module contents
  174. ---------------
  175. .. automodule:: super_gradients.training.models
  176. :members:
  177. :undoc-members:
  178. :show-inheritance:
Discard
@@ -7,13 +7,17 @@ Training package
 .. toctree::
 .. toctree::
    :maxdepth: 4
    :maxdepth: 4
    super_gradients.training
    super_gradients.training
+   super_gradients.training.dataloaders
    super_gradients.training.datasets
    super_gradients.training.datasets
    super_gradients.training.exceptions
    super_gradients.training.exceptions
+   super_gradients.training.kd_trainer
    super_gradients.training.legacy
    super_gradients.training.legacy
    super_gradients.training.losses
    super_gradients.training.losses
    super_gradients.training.metrics
    super_gradients.training.metrics
    super_gradients.training.models
    super_gradients.training.models
-   super_gradients.training.sg_model
+   super_gradients.training.sg_trainer
+   super_gradients.training.training_hyperparams
+   super_gradients.training.transforms
    super_gradients.training.utils
    super_gradients.training.utils
 
 
 super\_gradients.training module
 super\_gradients.training module
@@ -32,6 +36,14 @@ super\_gradients.training.datasets module
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
+super\_gradients.training.dataloaders module
+---------------------------------------
+
+.. automodule:: super_gradients.training.dataloaders
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 super\_gradients.training.exceptions module
 super\_gradients.training.exceptions module
 ---------------------------------------
 ---------------------------------------
 
 
@@ -40,6 +52,14 @@ super\_gradients.training.exceptions module
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
+super\_gradients.training.kd_trainer module
+---------------------------------------
+
+.. automodule:: super_gradients.training.kd_trainer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 super\_gradients.training.legacy module
 super\_gradients.training.legacy module
 ---------------------------------------
 ---------------------------------------
 
 
@@ -75,11 +95,26 @@ super\_gradients.training.models module
 super\_gradients.training.sg\_model module
 super\_gradients.training.sg\_model module
 ---------------------------------------------------
 ---------------------------------------------------
 
 
-.. automodule:: super_gradients.training.sg_model
+.. automodule:: super_gradients.training.sg_trainer
    :members:
    :members:
    :undoc-members:
    :undoc-members:
    :show-inheritance:
    :show-inheritance:
 
 
+super\_gradients.training.training_hyperparams module
+---------------------------------------
+
+.. automodule:: super_gradients.training.training_hyperparams
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+super\_gradients.training.transforms module
+---------------------------------------
+
+.. automodule:: super_gradients.training.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 
 super\_gradients.training.utils module
 super\_gradients.training.utils module
 ---------------------------------------------------
 ---------------------------------------------------
@@ -91,4 +126,3 @@ super\_gradients.training.utils module
 
 
 Module contents
 Module contents
 ---------------
 ---------------
-
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.training.sg\_model package
  2. ===========================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.sg\_model.sg\_model module
  6. ----------------------------------------------------
  7. .. automodule:: super_gradients.training.sg_model.sg_model
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.training.sg_model
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  1. super\_gradients.training.utils.optimizers package
  2. ==================================================
  3. Submodules
  4. ----------
  5. super\_gradients.training.utils.optimizers.rmsprop\_tf module
  6. -------------------------------------------------------------
  7. .. automodule:: super_gradients.training.utils.optimizers.rmsprop_tf
  8. :members:
  9. :undoc-members:
  10. :show-inheritance:
  11. Module contents
  12. ---------------
  13. .. automodule:: super_gradients.training.utils.optimizers
  14. :members:
  15. :undoc-members:
  16. :show-inheritance:
Discard
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
  1. super\_gradients.training.utils package
  2. =======================================
  3. Subpackages
  4. -----------
  5. .. toctree::
  6. :maxdepth: 4
  7. super_gradients.training.utils.optimizers
  8. Submodules
  9. ----------
  10. super\_gradients.training.utils.callbacks module
  11. ------------------------------------------------
  12. .. automodule:: super_gradients.training.utils.callbacks
  13. :members:
  14. :undoc-members:
  15. :show-inheritance:
  16. super\_gradients.training.utils.checkpoint\_utils module
  17. --------------------------------------------------------
  18. .. automodule:: super_gradients.training.utils.checkpoint_utils
  19. :members:
  20. :undoc-members:
  21. :show-inheritance:
  22. super\_gradients.training.utils.detection\_utils module
  23. -------------------------------------------------------
  24. .. automodule:: super_gradients.training.utils.detection_utils
  25. :members:
  26. :undoc-members:
  27. :show-inheritance:
  28. super\_gradients.training.utils.distributed\_training\_utils module
  29. -------------------------------------------------------------------
  30. .. automodule:: super_gradients.training.utils.distributed_training_utils
  31. :members:
  32. :undoc-members:
  33. :show-inheritance:
  34. super\_gradients.training.utils.early\_stopping module
  35. ------------------------------------------------------
  36. .. automodule:: super_gradients.training.utils.early_stopping
  37. :members:
  38. :undoc-members:
  39. :show-inheritance:
  40. super\_gradients.training.utils.ema module
  41. ------------------------------------------
  42. .. automodule:: super_gradients.training.utils.ema
  43. :members:
  44. :undoc-members:
  45. :show-inheritance:
  46. super\_gradients.training.utils.export\_utils module
  47. ----------------------------------------------------
  48. .. automodule:: super_gradients.training.utils.export_utils
  49. :members:
  50. :undoc-members:
  51. :show-inheritance:
  52. super\_gradients.training.utils.get\_model\_stats module
  53. --------------------------------------------------------
  54. .. automodule:: super_gradients.training.utils.get_model_stats
  55. :members:
  56. :undoc-members:
  57. :show-inheritance:
  58. super\_gradients.training.utils.module\_utils module
  59. ----------------------------------------------------
  60. .. automodule:: super_gradients.training.utils.module_utils
  61. :members:
  62. :undoc-members:
  63. :show-inheritance:
  64. super\_gradients.training.utils.optimizer\_utils module
  65. -------------------------------------------------------
  66. .. automodule:: super_gradients.training.utils.optimizer_utils
  67. :members:
  68. :undoc-members:
  69. :show-inheritance:
  70. super\_gradients.training.utils.regularization\_utils module
  71. ------------------------------------------------------------
  72. .. automodule:: super_gradients.training.utils.regularization_utils
  73. :members:
  74. :undoc-members:
  75. :show-inheritance:
  76. super\_gradients.training.utils.segmentation\_utils module
  77. ----------------------------------------------------------
  78. .. automodule:: super_gradients.training.utils.segmentation_utils
  79. :members:
  80. :undoc-members:
  81. :show-inheritance:
  82. super\_gradients.training.utils.sg\_model\_utils module
  83. -------------------------------------------------------
  84. .. automodule:: super_gradients.training.utils.sg_model_utils
  85. :members:
  86. :undoc-members:
  87. :show-inheritance:
  88. super\_gradients.training.utils.ssd\_utils module
  89. -------------------------------------------------
  90. .. automodule:: super_gradients.training.utils.ssd_utils
  91. :members:
  92. :undoc-members:
  93. :show-inheritance:
  94. super\_gradients.training.utils.utils module
  95. --------------------------------------------
  96. .. automodule:: super_gradients.training.utils.utils
  97. :members:
  98. :undoc-members:
  99. :show-inheritance:
  100. super\_gradients.training.utils.weight\_averaging\_utils module
  101. ---------------------------------------------------------------
  102. .. automodule:: super_gradients.training.utils.weight_averaging_utils
  103. :members:
  104. :undoc-members:
  105. :show-inheritance:
  106. Module contents
  107. ---------------
  108. .. automodule:: super_gradients.training.utils
  109. :members:
  110. :undoc-members:
  111. :show-inheritance:
Discard
@@ -1,15 +1,15 @@
 #!/usr/bin/env bash
 #!/usr/bin/env bash
 
 
 # Copy relevant files from root to documentation
 # Copy relevant files from root to documentation
-cp ./CONTRIBUTING.md documentation/source
-cp ./LICENSE.md documentation/source
-cp ./README.md documentation/source/welcome.md
+cp ../CONTRIBUTING.md ../documentation/source/CONTRIBUTING.md
+cp ../LICENSE.md ../documentation/source/LICENSE.md
+cp ../README.md ../documentation/source/welcome.md
 
 
 # Editing the links to contain assets/ instead of docs/assets in the urls
 # Editing the links to contain assets/ instead of docs/assets in the urls
-sed -i 's/docs\/assets/assets/g' documentation/source/welcome.md
+sed -i 's/docs\/assets/assets/g' ../documentation/source/welcome.md
 
 
 # Copying the assets to the documentation
 # Copying the assets to the documentation
-cd documentation && echo "Copying assets..."
+#cd ../documentation && echo "Copying assets..."
 
 
 # Compiling
 # Compiling
 # Copying to documentation/ to docs/ for github pages
 # Copying to documentation/ to docs/ for github pages
@@ -19,4 +19,4 @@ cd .. && sphinx-build -b html documentation/source docs && \
  echo "Successfully generated docs"
  echo "Successfully generated docs"
 
 
 # Starting an http server, mimicking github pages root directory (static HTML serving from docs/)
 # Starting an http server, mimicking github pages root directory (static HTML serving from docs/)
-#cd docs && python -m http.server 8080
+#cd docs && python -m http.server 8080
Discard
@@ -5,7 +5,21 @@ from super_gradients.common.data_connection import S3Connector
 from super_gradients.common.data_interface import DatasetDataInterface, ADNNModelRepositoryDataInterfaces
 from super_gradients.common.data_interface import DatasetDataInterface, ADNNModelRepositoryDataInterfaces
 from super_gradients.common.environment.env_helpers import init_trainer, is_distributed
 from super_gradients.common.environment.env_helpers import init_trainer, is_distributed
 from super_gradients.common.data_types import StrictLoad, DeepLearningTask, EvaluationType, MultiGPUMode, UpsampleMode
 from super_gradients.common.data_types import StrictLoad, DeepLearningTask, EvaluationType, MultiGPUMode, UpsampleMode
+from super_gradients.common.auto_logging.auto_logger import AutoLoggerConfig
 
 
-__all__ = ['explicit_params_validation', 'singleton', 'AWSConnector', 'DatasetDataInterface',
-           'ADNNModelRepositoryDataInterfaces', 'S3Connector', 'init_trainer', 'is_distributed',
-           'StrictLoad', 'DeepLearningTask', 'EvaluationType', 'MultiGPUMode', 'UpsampleMode']
+__all__ = [
+    "explicit_params_validation",
+    "singleton",
+    "AWSConnector",
+    "DatasetDataInterface",
+    "ADNNModelRepositoryDataInterfaces",
+    "S3Connector",
+    "init_trainer",
+    "is_distributed",
+    "StrictLoad",
+    "DeepLearningTask",
+    "EvaluationType",
+    "MultiGPUMode",
+    "UpsampleMode",
+    "AutoLoggerConfig",
+]
Discard
@@ -4,12 +4,13 @@ from enum import Enum
 class StrictLoad(Enum):
 class StrictLoad(Enum):
     """
     """
     Wrapper for adding more functionality to torch's strict_load parameter in load_state_dict().
     Wrapper for adding more functionality to torch's strict_load parameter in load_state_dict().
-        Attributes:
-            OFF              - Native torch "strict_load = off" behaviour. See nn.Module.load_state_dict() documentation for more details.
-            ON               - Native torch "strict_load = on" behaviour. See nn.Module.load_state_dict() documentation for more details.
-            NO_KEY_MATCHING  - Allows the usage of SuperGradient's adapt_checkpoint function, which loads a checkpoint by matching each
-                               layer's shapes (and bypasses the strict matching of the names of each layer (ie: disregards the state_dict key matching)).
+    Attributes:
+        OFF              - Native torch "strict_load = off" behaviour. See nn.Module.load_state_dict() documentation for more details.
+        ON               - Native torch "strict_load = on" behaviour. See nn.Module.load_state_dict() documentation for more details.
+        NO_KEY_MATCHING  - Allows the usage of SuperGradient's adapt_checkpoint function, which loads a checkpoint by matching each
+                           layer's shapes (and bypasses the strict matching of the names of each layer (ie: disregards the state_dict key matching)).
     """
     """
+
     OFF = False
     OFF = False
     ON = True
     ON = True
-    NO_KEY_MATCHING = 'no_key_matching'
+    NO_KEY_MATCHING = "no_key_matching"
Discard