Add global settings.yaml in USER_CONFIG_DIR (#125)

ultralytics/yolo/utils/__init__.py

@@ -10,6 +10,7 @@ from pathlib import Path
 
 import cv2
 import pandas as pd
+import yaml
 
 # Constants
 FILE = Path(__file__).resolve()
@@ -224,13 +225,6 @@ def set_logging(name=LOGGING_NAME, verbose=True):
                 "propagate": False,}}})
 
 
-set_logging(LOGGING_NAME)  # run before defining LOGGER
-LOGGER = logging.getLogger(LOGGING_NAME)  # define globally (used in train.py, val.py, detect.py, etc.)
-if platform.system() == 'Windows':
-    for fn in LOGGER.info, LOGGER.warning:
-        setattr(LOGGER, fn.__name__, lambda x: fn(emojis(x)))  # emoji safe logging
-
-
 class TryExcept(contextlib.ContextDecorator):
     # YOLOv5 TryExcept class. Usage: @TryExcept() decorator or 'with TryExcept():' context manager
     def __init__(self, msg=''):
@@ -253,3 +247,82 @@ def threaded(func):
         return thread
 
     return wrapper
+
+
+def get_settings(file=USER_CONFIG_DIR / 'settings.yaml'):
+    """
+    Function that loads a global settings YAML, or creates it and populates it with default values if it does not exist.
+
+    If the datasets or weights directories are set to None, the current working directory will be used.
+    The 'sync' setting determines whether analytics will be synced to help with YOLO development.
+    """
+    from ultralytics.yolo.utils.torch_utils import torch_distributed_zero_first
+
+    with torch_distributed_zero_first(RANK):
+        if not file.exists():
+            settings = {
+                'datasets_dir': None,  # default datasets directory. If None, current working directory is used.
+                'weights_dir': None,  # default weights directory. If None, current working directory is used.
+                'sync': True}  # sync analytics to help with YOLO development
+            yaml_save(file, settings)
+
+    return yaml_load(file)
+
+
+def yaml_save(file='data.yaml', data=None):
+    """
+    Save YAML data to a file.
+
+    Args:
+        file (str, optional): File name. Default is 'data.yaml'.
+        data (dict, optional): Data to save in YAML format. Default is None.
+
+    Returns:
+        None: Data is saved to the specified file.
+    """
+    file = Path(file)
+    if not file.parent.exists():
+        # Create parent directories if they don't exist
+        file.parent.mkdir(parents=True, exist_ok=True)
+
+    with open(file, 'w') as f:
+        # Dump data to file in YAML format, converting Path objects to strings
+        yaml.safe_dump({k: str(v) if isinstance(v, Path) else v for k, v in data.items()}, f, sort_keys=False)
+
+
+def yaml_load(file='data.yaml'):
+    """
+    Load YAML data from a file.
+
+    Args:
+        file (str, optional): File name. Default is 'data.yaml'.
+
+    Returns:
+        dict: YAML data and file name.
+    """
+    with open(file, errors='ignore') as f:
+        # Add YAML filename to dict and return
+        return {**yaml.safe_load(f), 'yaml_file': file}
+
+
+# Run below code on utils init -----------------------------------------------------------------------------------------
+
+# Set logger
+set_logging(LOGGING_NAME)  # run before defining LOGGER
+LOGGER = logging.getLogger(LOGGING_NAME)  # define globally (used in train.py, val.py, detect.py, etc.)
+if platform.system() == 'Windows':
+    for fn in LOGGER.info, LOGGER.warning:
+        setattr(LOGGER, fn.__name__, lambda x: fn(emojis(x)))  # emoji safe logging
+
+# Check first-install steps
+SETTINGS = get_settings()
+
+
+def set_settings(kwargs, file=USER_CONFIG_DIR / 'settings.yaml'):
+    """
+    Function that runs on a first-time ultralytics package installation to set up global settings and create necessary
+    directories.
+    """
+    SETTINGS.update(kwargs)
+
+    yaml_save(file, SETTINGS)

ultralytics/yolo/utils/files.py

@@ -6,8 +6,6 @@ from datetime import datetime
 from pathlib import Path
 from zipfile import ZipFile
 
-import yaml
-
 
 class WorkingDirectory(contextlib.ContextDecorator):
     # Usage: @WorkingDirectory(dir) decorator or 'with WorkingDirectory(dir):' context manager
@@ -57,18 +55,6 @@ def increment_path(path, exist_ok=False, sep='', mkdir=False):
     return path
 
 
-def yaml_save(file='data.yaml', data=None):
-    # Single-line safe yaml saving
-    with open(file, 'w') as f:
-        yaml.safe_dump({k: str(v) if isinstance(v, Path) else v for k, v in data.items()}, f, sort_keys=False)
-
-
-def yaml_load(file='data.yaml'):
-    # Single-line safe yaml loading
-    with open(file, errors='ignore') as f:
-        return {**yaml.safe_load(f), 'yaml_file': file}  # add YAML filename to dict and return
-
-
 def unzip_file(file, path=None, exclude=('.DS_Store', '__MACOSX')):
     # Unzip a *.zip file to path/, excluding files containing strings in exclude list
     if path is None:

ultralytics/yolo/utils/instance.py

@@ -162,13 +162,15 @@ class Bboxes:
 
 class Instances:
 
-    def __init__(self, bboxes, segments=[], keypoints=None, bbox_format="xywh", normalized=True) -> None:
+    def __init__(self, bboxes, segments=None, keypoints=None, bbox_format="xywh", normalized=True) -> None:
         """
         Args:
             bboxes (ndarray): bboxes with shape [N, 4].
             segments (list | ndarray): segments.
             keypoints (ndarray): keypoints with shape [N, 17, 2].
         """
+        if segments is None:
+            segments = []
         self._bboxes = Bboxes(bboxes=bboxes, format=bbox_format)
         self.keypoints = keypoints
         self.normalized = normalized