Start export implementation (#110)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

ultralytics/yolo/configs/__init__.py

@@ -0,0 +1,28 @@
+from pathlib import Path
+from typing import Dict, Union
+
+from omegaconf import DictConfig, OmegaConf
+
+from ultralytics.yolo.configs.hydra_patch import check_config_mismatch
+
+
+def get_config(config: Union[str, DictConfig], overrides: Union[str, Dict] = {}):
+    """
+    Accepts yaml file name or DictConfig containing experiment configuration.
+    Returns training args namespace
+    :param overrides: Overrides str or Dict
+    :param config: Optional file name or DictConfig object
+    """
+    if isinstance(config, (str, Path)):
+        config = OmegaConf.load(config)
+    elif isinstance(config, Dict):
+        config = OmegaConf.create(config)
+    # override
+    if isinstance(overrides, str):
+        overrides = OmegaConf.load(overrides)
+    elif isinstance(overrides, Dict):
+        overrides = OmegaConf.create(overrides)
+
+    check_config_mismatch(dict(overrides).keys(), dict(config).keys())
+
+    return OmegaConf.merge(config, overrides)

ultralytics/yolo/configs/default.yaml

@@ -0,0 +1,111 @@
+# YOLO 🚀 by Ultralytics, GPL-3.0 license
+# Default training settings and hyperparameters for medium-augmentation COCO training
+
+# Task and Mode
+task: "classify"  # choices=['detect', 'segment', 'classify', 'init'] # init is a special case
+mode: "train"  # choice=['train', 'val', 'predict']
+
+# Train settings -------------------------------------------------------------------------------------------------------
+model: null  # i.e. yolov5s.pt, yolo.yaml
+data: null  # i.e. coco128.yaml
+epochs: 100
+batch_size: 16
+imgsz: 640
+nosave: False
+cache: False  # True/ram, disk or False
+device: ''  # cuda device, i.e. 0 or 0,1,2,3 or cpu
+workers: 8
+project: null
+name: null
+exist_ok: False
+pretrained: False
+optimizer: 'SGD'  # choices=['SGD', 'Adam', 'AdamW', 'RMSProp']
+verbose: False
+seed: 0
+deterministic: True
+local_rank: -1
+single_cls: False  # train multi-class data as single-class
+image_weights: False  # use weighted image selection for training
+rect: False  # support rectangular training
+cos_lr: False  # use cosine LR scheduler
+close_mosaic: 10  # disable mosaic for final 10 epochs
+# Segmentation
+overlap_mask: True  # masks overlap
+mask_ratio: 4  # mask downsample ratio
+# Classification
+dropout: False  # use dropout
+resume: False
+
+
+# Val/Test settings ----------------------------------------------------------------------------------------------------
+noval: False
+save_json: False
+save_hybrid: False
+conf_thres: 0.001
+iou_thres: 0.7
+max_det: 300
+half: False
+dnn: False  # use OpenCV DNN for ONNX inference
+plots: True
+
+# Prediction settings --------------------------------------------------------------------------------------------------
+source: "ultralytics/assets/"
+view_img: False
+save_txt: False
+save_conf: False
+save_crop: False
+hide_labels: False  # hide labels
+hide_conf: False
+vid_stride: 1  # video frame-rate stride
+line_thickness: 3  # bounding box thickness (pixels)
+update: False  # Update all models
+visualize: False
+augment: False
+agnostic_nms: False  # class-agnostic NMS
+retina_masks: False
+
+# Export settings ------------------------------------------------------------------------------------------------------
+keras: False  # use Keras
+optimize: False  # TorchScript: optimize for mobile
+int8: False  # CoreML/TF INT8 quantization
+dynamic: False  # ONNX/TF/TensorRT: dynamic axes
+simplify: False  # ONNX: simplify model
+opset: 17  # ONNX: opset version
+workspace: 4  # TensorRT: workspace size (GB)
+
+# Hyperparameters ------------------------------------------------------------------------------------------------------
+lr0: 0.01  # initial learning rate (SGD=1E-2, Adam=1E-3)
+lrf: 0.01  # final OneCycleLR learning rate (lr0 * lrf)
+momentum: 0.937  # SGD momentum/Adam beta1
+weight_decay: 0.0005  # optimizer weight decay 5e-4
+warmup_epochs: 3.0  # warmup epochs (fractions ok)
+warmup_momentum: 0.8  # warmup initial momentum
+warmup_bias_lr: 0.1  # warmup initial bias lr
+box: 7.5  # box loss gain
+cls: 0.5  # cls loss gain (scale with pixels)
+dfl: 1.5  # dfl loss gain
+fl_gamma: 0.0  # focal loss gamma (efficientDet default gamma=1.5)
+label_smoothing: 0.0
+nbs: 64  # nominal batch size
+hsv_h: 0.015  # image HSV-Hue augmentation (fraction)
+hsv_s: 0.7  # image HSV-Saturation augmentation (fraction)
+hsv_v: 0.4  # image HSV-Value augmentation (fraction)
+degrees: 0.0  # image rotation (+/- deg)
+translate: 0.1  # image translation (+/- fraction)
+scale: 0.5  # image scale (+/- gain)
+shear: 0.0  # image shear (+/- deg)
+perspective: 0.0  # image perspective (+/- fraction), range 0-0.001
+flipud: 0.0  # image flip up-down (probability)
+fliplr: 0.5  # image flip left-right (probability)
+mosaic: 1.0  # image mosaic (probability)
+mixup: 0.0  # image mixup (probability)
+copy_paste: 0.0  # segment copy-paste (probability)
+
+# For debugging. Don't change
+v5loader: False
+
+# Hydra configs --------------------------------------------------------------------------------------------------------
+hydra:
+  output_subdir: null  # disable hydra directory creation
+  run:
+    dir: .

ultralytics/yolo/configs/hydra_patch.py

@@ -0,0 +1,75 @@
+import sys
+from difflib import get_close_matches
+from textwrap import dedent
+
+import hydra
+from hydra.errors import ConfigCompositionException
+from omegaconf import OmegaConf, open_dict  # noqa
+from omegaconf.errors import ConfigAttributeError, ConfigKeyError, OmegaConfBaseException  # noqa
+
+from ultralytics.yolo.utils import LOGGER, colorstr
+
+
+def override_config(overrides, cfg):
+    override_keys = [override.key_or_group for override in overrides]
+    check_config_mismatch(override_keys, cfg.keys())
+    for override in overrides:
+        if override.package is not None:
+            raise ConfigCompositionException(f"Override {override.input_line} looks like a config group"
+                                             f" override, but config group '{override.key_or_group}' does not exist.")
+
+        key = override.key_or_group
+        value = override.value()
+        try:
+            if override.is_delete():
+                config_val = OmegaConf.select(cfg, key, throw_on_missing=False)
+                if config_val is None:
+                    raise ConfigCompositionException(f"Could not delete from config. '{override.key_or_group}'"
+                                                     " does not exist.")
+                elif value is not None and value != config_val:
+                    raise ConfigCompositionException("Could not delete from config. The value of"
+                                                     f" '{override.key_or_group}' is {config_val} and not"
+                                                     f" {value}.")
+
+                last_dot = key.rfind(".")
+                with open_dict(cfg):
+                    if last_dot == -1:
+                        del cfg[key]
+                    else:
+                        node = OmegaConf.select(cfg, key[:last_dot])
+                        del node[key[last_dot + 1:]]
+
+            elif override.is_add():
+                if OmegaConf.select(cfg, key, throw_on_missing=False) is None or isinstance(value, (dict, list)):
+                    OmegaConf.update(cfg, key, value, merge=True, force_add=True)
+                else:
+                    assert override.input_line is not None
+                    raise ConfigCompositionException(
+                        dedent(f"""\
+                    Could not append to config. An item is already at '{override.key_or_group}'.
+                    Either remove + prefix: '{override.input_line[1:]}'
+                    Or add a second + to add or override '{override.key_or_group}': '+{override.input_line}'
+                    """))
+            elif override.is_force_add():
+                OmegaConf.update(cfg, key, value, merge=True, force_add=True)
+            else:
+                try:
+                    OmegaConf.update(cfg, key, value, merge=True)
+                except (ConfigAttributeError, ConfigKeyError) as ex:
+                    raise ConfigCompositionException(f"Could not override '{override.key_or_group}'."
+                                                     f"\nTo append to your config use +{override.input_line}") from ex
+        except OmegaConfBaseException as ex:
+            raise ConfigCompositionException(f"Error merging override {override.input_line}").with_traceback(
+                sys.exc_info()[2]) from ex
+
+
+def check_config_mismatch(overrides, cfg):
+    mismatched = [option for option in overrides if option not in cfg and 'hydra.' not in option]
+
+    for option in mismatched:
+        LOGGER.info(f"{colorstr(option)} is not a valid key. Similar keys: {get_close_matches(option, cfg, 3, 0.6)}")
+    if mismatched:
+        exit()
+
+
+hydra._internal.config_loader_impl.ConfigLoaderImpl._apply_overrides_to_config = override_config