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

#863 Generate docs

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:mkdocs_squashed
2 changed files with 56 additions and 13 deletions
  1. 16
    13
      README.md
  2. 40
    0
      mkdocs.yml
@@ -1,4 +1,4 @@
-<div align="center">
+<div align="center" markdown="1">
   <img src="docs/assets/SG_img/SG - Horizontal Glow 2.png" width="600"/>
   <img src="docs/assets/SG_img/SG - Horizontal Glow 2.png" width="600"/>
  <br/><br/>
  <br/><br/>
   
   
@@ -7,8 +7,9 @@
 
 
 #### Version 3 is out! Notebooks have been updated!
 #### Version 3 is out! Notebooks have been updated!
 ______________________________________________________________________
 ______________________________________________________________________
-  
-  <p align="center">
+</div>  
+<div align="center">
+<p align="center">
   <a href="https://www.supergradients.com/">Website</a> •
   <a href="https://www.supergradients.com/">Website</a> •
   <a href="https://deci-ai.github.io/super-gradients/welcome.html">Docs</a> •
   <a href="https://deci-ai.github.io/super-gradients/welcome.html">Docs</a> •
   <a href="#getting-started">Getting Started</a> •
   <a href="#getting-started">Getting Started</a> •
@@ -25,10 +26,12 @@ ______________________________________________________________________
   <a href="https://github.com/Deci-AI/super-gradients/releases"><img src="https://img.shields.io/github/v/release/Deci-AI/super-gradients" />
   <a href="https://github.com/Deci-AI/super-gradients/releases"><img src="https://img.shields.io/github/v/release/Deci-AI/super-gradients" />
   <a href="https://join.slack.com/t/supergradients-comm52/shared_invite/zt-10vz6o1ia-b_0W5jEPEnuHXm087K~t8Q"><img src="https://img.shields.io/badge/slack-community-blueviolet" />
   <a href="https://join.slack.com/t/supergradients-comm52/shared_invite/zt-10vz6o1ia-b_0W5jEPEnuHXm087K~t8Q"><img src="https://img.shields.io/badge/slack-community-blueviolet" />
   <a href="https://github.com/Deci-AI/super-gradients/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" />
   <a href="https://github.com/Deci-AI/super-gradients/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" />
-  <a href="https://deci-ai.github.io/super-gradients/welcome.html"><img src="https://img.shields.io/badge/docs-sphinx-brightgreen" />
+  <a href="https://deci-ai.github.io/super-gradients/welcome.html"><img src="https://img.shields.io/badge/docs-sphinx-brightgreen" /></a>
 </p>    
 </p>    
 </div>
 </div>
 
 
+______________________________________________________________________
+
 ## Build with SuperGradients
 ## Build with SuperGradients
 __________________________________________________________________________________________________________
 __________________________________________________________________________________________________________
 
 
@@ -310,7 +313,7 @@ Recipes support out of the box every model, metric or loss that is implemented i
  </br></br>
  </br></br>
 
 
  </br>
  </br>
-<details>
+<details markdown="1">
   <summary><h3>Using Distributed Data Parallel (DDP) </h3></summary>
   <summary><h3>Using Distributed Data Parallel (DDP) </h3></summary>
 
 
 #### Why use DDP ?
 #### Why use DDP ?
@@ -422,7 +425,7 @@ There is no clear rule, but a rule of thumb seems to be to [linearly increase th
 
 
 </details>
 </details>
 
 
-<details>
+<details markdown="1">
 <summary><h3> Easily change architectures parameters </h3></summary>
 <summary><h3> Easily change architectures parameters </h3></summary>
 
 
 ```python
 ```python
@@ -440,7 +443,7 @@ backbone_resnet18 = models.get(model_name="resnet18", arch_params={"backbone_mod
 
 
 </details>
 </details>
 
 
-<details>
+<details markdown="1">
 
 
 <summary><h3> Using phase callbacks </h3></summary>  
 <summary><h3> Using phase callbacks </h3></summary>  
   
   
@@ -469,7 +472,7 @@ train_params = {"phase_callbacks": phase_callbacks}
 
 
 </details>
 </details>
 
 
-<details>
+<details markdown="1">
 
 
 <summary><h3> Integration to DagsHub </h3></summary>    
 <summary><h3> Integration to DagsHub </h3></summary>    
 
 
@@ -521,7 +524,7 @@ train_params = { ... # training parameters
 
 
 </details>
 </details>
 
 
-<details>
+<details markdown="1">
 
 
 <summary><h3> Integration to ClearML </h3></summary>    
 <summary><h3> Integration to ClearML </h3></summary>    
     
     
@@ -549,7 +552,7 @@ train_params = { ... # training parameters
 ## Installation Methods
 ## Installation Methods
 __________________________________________________________________________________________________________
 __________________________________________________________________________________________________________
 ### Prerequisites
 ### Prerequisites
-<details>
+<details markdown="1">
   
   
 <summary>General requirements</summary>
 <summary>General requirements</summary>
   
   
@@ -560,7 +563,7 @@ ________________________________________________________________________________
 
 
 </details>
 </details>
     
     
-<details>
+<details markdown="1">
   
   
 <summary>To train on nvidia GPUs</summary>
 <summary>To train on nvidia GPUs</summary>
   
   
@@ -572,7 +575,7 @@ ________________________________________________________________________________
     
     
 ### Quick Installation
 ### Quick Installation
 
 
-<details>
+<details markdown="1">
   
   
 <summary>Install stable version using PyPi</summary>
 <summary>Install stable version using PyPi</summary>
 
 
@@ -585,7 +588,7 @@ That's it !
 
 
 </details>
 </details>
     
     
-<details>
+<details markdown="1">
   
   
 <summary>Install using GitHub</summary>
 <summary>Install using GitHub</summary>
 
 
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
  1. site_name: super-gradients
  2. nav:
  3. - Welcome:
  4. - Intro: ./documentation/source/welcome.md
  5. - Installation: ./documentation/source/installation.md
  6. - Model Zoo: ./documentation/source/model_zoo.md
  7. - Quick Start:
  8. - Basic: ./documentation/source/QuickstartBasicToolkit.md
  9. - Classification: ./documentation/source/Example_Classification.md
  10. - Object Detection: ./documentation/source/ObjectDetection.md
  11. - Segmentation: ./documentation/source/Segmentation.md
  12. - Pose Estimation: ./documentation/source/PoseEstimation.md
  13. - Training an external model: ./documentation/source/Example_Training-an-external-model.md
  14. - Tutorials:
  15. - Models: ./documentation/source/models.md
  16. - Dataset:
  17. - Data: ./documentation/source/Data.md
  18. - Computer Vision Datasets: ./src/super_gradients/training/datasets/Dataset_Setup_Instructions.md
  19. - Loss functions: ./documentation/source/Losses.md
  20. - LR schedulers: ./documentation/source/LRScheduling.md
  21. - Metrics: ./documentation/source/Metrics.md
  22. - Optimizers: ./documentation/source/optimizers.md
  23. - Phase Callbacks: ./documentation/source/PhaseCallbacks.md
  24. - YAMLs and Recipes:
  25. - Configurations: ./documentation/source/configuration_files.md
  26. - Recipes: ./src/super_gradients/recipes/Training_Recipes.md
  27. - Checkpoints: ./documentation/source/Checkpoints.md
  28. - Docker: ./documentation/source/SGDocker.md
  29. - Output Adapter: ./documentation/source/DetectionOutputAdapter.md
  30. - Features:
  31. - Training Modes: ./documentation/source/device.md
  32. - Logging: ./documentation/source/logs.md
  33. - Experiment Monitoring: ./documentation/source/experiment_monitoring.md
  34. - Exponential Moving Average (EMA): ./documentation/source/EMA.md
  35. - Automatic Mixed Precision (AMP): ./documentation/source/average_mixed_precision.md
  36. - Knowledge Distillation (KD): ./documentation/source/KD.md
  37. - Quantization (PTQ & QAT): ./documentation/source/ptq_qat.md
  38. - Troubleshooting: ./documentation/source/troubleshooting.md
  39. - Contribution: ./documentation/source/CONTRIBUTING.md
  40. - Code: this_is_automatically_generated.md
Discard