📝 [Add] function document (by autodoc)

docs/6_function_docs/0_solver.rst

@@ -1,4 +1,12 @@
-.. _Solver:
-
 Solver
 ======
+
+.. automodule:: yolo.tools.solver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: yolo.utils.bounding_box_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/6_function_docs/3_config.rst

@@ -0,0 +1,188 @@
+Config
+======
+
+
+
+.. autoclass:: yolo.config.config.Config
+    :members:
+    :undoc-members:
+
+.. automodule:: yolo.config.config
+    :members:
+    :undoc-members:
+
+
+
+.. mermaid::
+
+    classDiagram
+    class AnchorConfig {
+        List~int~ strides
+        Optional~int~ reg_max
+        Optional~int~ anchor_num
+        List~List~int~~ anchor
+    }
+
+    class LayerConfig {
+        Dict args
+        Union~List~int~~ source
+        str tags
+    }
+
+    class BlockConfig {
+        List~Dict~LayerConfig~~ block
+    }
+
+    class ModelConfig {
+        Optional~str~ name
+        AnchorConfig anchor
+        Dict~BlockConfig~ model
+    }
+
+    AnchorConfig --> ModelConfig
+    LayerConfig --> BlockConfig
+    BlockConfig --> ModelConfig
+
+.. mermaid::
+
+    classDiagram
+    class DownloadDetail {
+        str url
+        int file_size
+    }
+
+    class DownloadOptions {
+        Dict~DownloadDetail~ details
+    }
+
+    class DatasetConfig {
+        str path
+        int class_num
+        List~str~ class_list
+        Optional~DownloadOptions~ auto_download
+    }
+
+    class DataConfig {
+        bool shuffle
+        int batch_size
+        bool pin_memory
+        int cpu_num
+        List~int~ image_size
+        Dict~int~ data_augment
+        Optional~Union~str~~ source
+    }
+
+    DownloadDetail --> DownloadOptions
+    DownloadOptions --> DatasetConfig
+
+.. mermaid::
+
+    classDiagram
+    class OptimizerArgs {
+        float lr
+        float weight_decay
+    }
+
+    class OptimizerConfig {
+        str type
+        OptimizerArgs args
+    }
+
+    class MatcherConfig {
+        str iou
+        int topk
+        Dict~str~ factor
+    }
+
+    class LossConfig {
+        Dict~str~ objective
+        Union~bool~ aux
+        MatcherConfig matcher
+    }
+
+    class SchedulerConfig {
+        str type
+        Dict~str~ warmup
+        Dict~str~ args
+    }
+
+    class EMAConfig {
+        bool enabled
+        float decay
+    }
+
+    class TrainConfig {
+        str task
+        int epoch
+        DataConfig data
+        OptimizerConfig optimizer
+        LossConfig loss
+        SchedulerConfig scheduler
+        EMAConfig ema
+        ValidationConfig validation
+    }
+
+    class NMSConfig {
+        int min_confidence
+        int min_iou
+    }
+
+    class InferenceConfig {
+        str task
+        NMSConfig nms
+        DataConfig data
+        Optional~None~ fast_inference
+        bool save_predict
+    }
+
+    class ValidationConfig {
+        str task
+        NMSConfig nms
+        DataConfig data
+    }
+
+    OptimizerArgs --> OptimizerConfig
+    OptimizerConfig --> TrainConfig
+    MatcherConfig --> LossConfig
+    LossConfig --> TrainConfig
+    SchedulerConfig --> TrainConfig
+    EMAConfig --> TrainConfig
+    NMSConfig --> InferenceConfig
+    NMSConfig --> ValidationConfig
+
+
+.. mermaid::
+
+    classDiagram
+    class GeneralConfig {
+        str name
+        Union~str~ device
+        int cpu_num
+        List~int~ class_idx_id
+        List~int~ image_size
+        str out_path
+        bool exist_ok
+        int lucky_number
+        bool use_wandb
+        bool use_TensorBoard
+        Optional~str~ weight
+    }
+
+.. mermaid::
+
+    classDiagram
+    class Config {
+        Union~ValidationConfig~ task
+        DatasetConfig dataset
+        ModelConfig model
+        GeneralConfig model
+    }
+
+    DatasetConfig --> Config
+    DataConfig --> TrainConfig
+    DataConfig --> InferenceConfig
+    DataConfig --> ValidationConfig
+    InferenceConfig --> Config
+    ValidationConfig --> Config
+    TrainConfig --> Config
+    GeneralConfig --> Config

docs/6_function_docs/4_dataloader.rst

@@ -0,0 +1,8 @@
+Dataloader
+==========
+
+
+
+.. automodule:: yolo.tools.data_loader
+    :members:
+    :undoc-members:

docs/MODELS.md

@@ -1,30 +0,0 @@
-# YOLO Model Zoo
-
-Welcome to the YOLOv9 Model Zoo! Here, you will find a variety of pre-trained models tailored to different use cases and performance needs. Each model comes with detailed information about its training regime, performance metrics, and usage instructions.
-
-## Standard Models
-
-These models are trained on common datasets like COCO and provide a balance between speed and accuracy.
-
-
-| Model | Support? |Test Size | AP<sup>val</sup> | AP<sub>50</sub><sup>val</sup> | AP<sub>75</sub><sup>val</sup> | Param. | FLOPs |
-| :-- | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
-| [**YOLOv9-S**]() |✅ | 640  | **46.8%** | **63.4%** | **50.7%** | **7.1M** | **26.4G** |
-| [**YOLOv9-M**]() |✅ | 640  | **51.4%** | **68.1%** | **56.1%** | **20.0M** | **76.3G** |
-| [**YOLOv9-C**]() |✅ | 640  | **53.0%** | **70.2%** | **57.8%** | **25.3M** | **102.1G** |
-| [**YOLOv9-E**]() | 🔧 | 640  | **55.6%** | **72.8%** | **60.6%** | **57.3M** | **189.0G** |
-|  |  |  |  |  |  |  |
-| [**YOLOv7**]() |🔧 | 640  | **51.4%** | **69.7%** | **55.9%** |
-| [**YOLOv7-X**]() |🔧 | 640  | **53.1%** | **71.2%** | **57.8%** |
-| [**YOLOv7-W6**]() | 🔧 | 1280 | **54.9%** | **72.6%** | **60.1%** |
-| [**YOLOv7-E6**]() | 🔧 | 1280 | **56.0%** | **73.5%** | **61.2%** |
-| [**YOLOv7-D6**]() | 🔧 | 1280 | **56.6%** | **74.0%** | **61.8%** |
-| [**YOLOv7-E6E**]() | 🔧 | 1280 | **56.8%** | **74.4%** | **62.1%** |
-
-## Download and Usage Instructions
-
-To use these models, download them from the links provided and use the following command to run detection:
-
-```bash
-$yolo detect weights=path/to/model.pt img=640 conf=0.25 source=your_image.jpg
-```