Zum Inhalt springen

Referenz f├╝r ultralytics/utils/__init__.py

Hinweis

Diese Datei ist verf├╝gbar unter https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/init.py. Wenn du ein Problem entdeckst, hilf bitte mit, es zu beheben, indem du einen Pull Request ­čŤá´ŞĆ einreichst. Vielen Dank ­čÖĆ!



ultralytics.utils.TQDM

Basen: tqdm

Benutzerdefinierte Ultralytics tqdm-Klasse mit verschiedenen Standardargumenten.

Parameter:

Name Typ Beschreibung Standard
*args list

Positionale Argumente, die an das urspr├╝ngliche tqdm ├╝bergeben werden.

()
**kwargs dict

Schl├╝sselwortargumente, wobei benutzerdefinierte Standardwerte angewendet werden.

{}
Quellcode in ultralytics/utils/__init__.py
class TQDM(tqdm_original):
    """
    Custom Ultralytics tqdm class with different default arguments.

    Args:
        *args (list): Positional arguments passed to original tqdm.
        **kwargs (dict): Keyword arguments, with custom defaults applied.
    """

    def __init__(self, *args, **kwargs):
        """
        Initialize custom Ultralytics tqdm class with different default arguments.

        Note these can still be overridden when calling TQDM.
        """
        kwargs["disable"] = not VERBOSE or kwargs.get("disable", False)  # logical 'and' with default value if passed
        kwargs.setdefault("bar_format", TQDM_BAR_FORMAT)  # override default value if passed
        super().__init__(*args, **kwargs)

__init__(*args, **kwargs)

Initialisiere die benutzerdefinierte Ultralytics tqdm-Klasse mit verschiedenen Standardargumenten.

Beachte, dass diese beim Aufruf von TQDM ├╝berschrieben werden k├Ânnen.

Quellcode in ultralytics/utils/__init__.py
def __init__(self, *args, **kwargs):
    """
    Initialize custom Ultralytics tqdm class with different default arguments.

    Note these can still be overridden when calling TQDM.
    """
    kwargs["disable"] = not VERBOSE or kwargs.get("disable", False)  # logical 'and' with default value if passed
    kwargs.setdefault("bar_format", TQDM_BAR_FORMAT)  # override default value if passed
    super().__init__(*args, **kwargs)



ultralytics.utils.SimpleClass

Ultralytics SimpleClass ist eine Basisklasse, die hilfreiche Methoden zur String-Darstellung, Fehlerberichterstattung und Attribut Zugriffsmethoden f├╝r eine einfachere Fehlersuche und Verwendung.

Quellcode in ultralytics/utils/__init__.py
class SimpleClass:
    """Ultralytics SimpleClass is a base class providing helpful string representation, error reporting, and attribute
    access methods for easier debugging and usage.
    """

    def __str__(self):
        """Return a human-readable string representation of the object."""
        attr = []
        for a in dir(self):
            v = getattr(self, a)
            if not callable(v) and not a.startswith("_"):
                if isinstance(v, SimpleClass):
                    # Display only the module and class name for subclasses
                    s = f"{a}: {v.__module__}.{v.__class__.__name__} object"
                else:
                    s = f"{a}: {repr(v)}"
                attr.append(s)
        return f"{self.__module__}.{self.__class__.__name__} object with attributes:\n\n" + "\n".join(attr)

    def __repr__(self):
        """Return a machine-readable string representation of the object."""
        return self.__str__()

    def __getattr__(self, attr):
        """Custom attribute access error message with helpful information."""
        name = self.__class__.__name__
        raise AttributeError(f"'{name}' object has no attribute '{attr}'. See valid attributes below.\n{self.__doc__}")

__getattr__(attr)

Benutzerdefinierte Attribut-Zugriffsfehlermeldung mit hilfreichen Informationen.

Quellcode in ultralytics/utils/__init__.py
def __getattr__(self, attr):
    """Custom attribute access error message with helpful information."""
    name = self.__class__.__name__
    raise AttributeError(f"'{name}' object has no attribute '{attr}'. See valid attributes below.\n{self.__doc__}")

__repr__()

Gibt eine maschinenlesbare String-Repr├Ąsentation des Objekts zur├╝ck.

Quellcode in ultralytics/utils/__init__.py
def __repr__(self):
    """Return a machine-readable string representation of the object."""
    return self.__str__()

__str__()

Gibt eine menschenlesbare String-Repr├Ąsentation des Objekts zur├╝ck.

Quellcode in ultralytics/utils/__init__.py
def __str__(self):
    """Return a human-readable string representation of the object."""
    attr = []
    for a in dir(self):
        v = getattr(self, a)
        if not callable(v) and not a.startswith("_"):
            if isinstance(v, SimpleClass):
                # Display only the module and class name for subclasses
                s = f"{a}: {v.__module__}.{v.__class__.__name__} object"
            else:
                s = f"{a}: {repr(v)}"
            attr.append(s)
    return f"{self.__module__}.{self.__class__.__name__} object with attributes:\n\n" + "\n".join(attr)



ultralytics.utils.IterableSimpleNamespace

Basen: SimpleNamespace

Ultralytics IterableSimpleNamespace ist eine Erweiterungsklasse von SimpleNamespace, die die Funktionalit├Ąt von Iterables und die Verwendung mit dict() und for-Schleifen erm├Âglicht.

Quellcode in ultralytics/utils/__init__.py
class IterableSimpleNamespace(SimpleNamespace):
    """Ultralytics IterableSimpleNamespace is an extension class of SimpleNamespace that adds iterable functionality and
    enables usage with dict() and for loops.
    """

    def __iter__(self):
        """Return an iterator of key-value pairs from the namespace's attributes."""
        return iter(vars(self).items())

    def __str__(self):
        """Return a human-readable string representation of the object."""
        return "\n".join(f"{k}={v}" for k, v in vars(self).items())

    def __getattr__(self, attr):
        """Custom attribute access error message with helpful information."""
        name = self.__class__.__name__
        raise AttributeError(
            f"""
            '{name}' object has no attribute '{attr}'. This may be caused by a modified or out of date ultralytics
            'default.yaml' file.\nPlease update your code with 'pip install -U ultralytics' and if necessary replace
            {DEFAULT_CFG_PATH} with the latest version from
            https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/default.yaml
            """
        )

    def get(self, key, default=None):
        """Return the value of the specified key if it exists; otherwise, return the default value."""
        return getattr(self, key, default)

__getattr__(attr)

Benutzerdefinierte Attribut-Zugriffsfehlermeldung mit hilfreichen Informationen.

Quellcode in ultralytics/utils/__init__.py
def __getattr__(self, attr):
    """Custom attribute access error message with helpful information."""
    name = self.__class__.__name__
    raise AttributeError(
        f"""
        '{name}' object has no attribute '{attr}'. This may be caused by a modified or out of date ultralytics
        'default.yaml' file.\nPlease update your code with 'pip install -U ultralytics' and if necessary replace
        {DEFAULT_CFG_PATH} with the latest version from
        https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/default.yaml
        """
    )

__iter__()

Gibt einen Iterator von Schl├╝ssel-Wert-Paaren aus den Attributen des Namespaces zur├╝ck.

Quellcode in ultralytics/utils/__init__.py
def __iter__(self):
    """Return an iterator of key-value pairs from the namespace's attributes."""
    return iter(vars(self).items())

__str__()

Gibt eine menschenlesbare String-Repr├Ąsentation des Objekts zur├╝ck.

Quellcode in ultralytics/utils/__init__.py
def __str__(self):
    """Return a human-readable string representation of the object."""
    return "\n".join(f"{k}={v}" for k, v in vars(self).items())

get(key, default=None)

Gibt den Wert des angegebenen Schl├╝ssels zur├╝ck, wenn er existiert; andernfalls wird der Standardwert zur├╝ckgegeben.

Quellcode in ultralytics/utils/__init__.py
def get(self, key, default=None):
    """Return the value of the specified key if it exists; otherwise, return the default value."""
    return getattr(self, key, default)



ultralytics.utils.ThreadingLocked

Eine Dekoratorklasse, die eine thread-sichere Ausf├╝hrung einer Funktion oder Methode gew├Ąhrleistet. Diese Klasse kann als Dekorator verwendet werden verwendet werden, um sicherzustellen, dass bei einem Aufruf der dekorierten Funktion von mehreren Threads aus jeweils nur ein Thread in der Lage sein wird die Funktion ausf├╝hren kann.

Attribute:

Name Typ Beschreibung
lock Lock

Ein Sperrobjekt, das den Zugriff auf die dekorierte Funktion verwaltet.

Beispiel
from ultralytics.utils import ThreadingLocked

@ThreadingLocked()
def my_function():
    # Your code here
    pass
Quellcode in ultralytics/utils/__init__.py
class ThreadingLocked:
    """
    A decorator class for ensuring thread-safe execution of a function or method. This class can be used as a decorator
    to make sure that if the decorated function is called from multiple threads, only one thread at a time will be able
    to execute the function.

    Attributes:
        lock (threading.Lock): A lock object used to manage access to the decorated function.

    Example:
        ```python
        from ultralytics.utils import ThreadingLocked

        @ThreadingLocked()
        def my_function():
            # Your code here
            pass
        ```
    """

    def __init__(self):
        """Initializes the decorator class for thread-safe execution of a function or method."""
        self.lock = threading.Lock()

    def __call__(self, f):
        """Run thread-safe execution of function or method."""
        from functools import wraps

        @wraps(f)
        def decorated(*args, **kwargs):
            """Applies thread-safety to the decorated function or method."""
            with self.lock:
                return f(*args, **kwargs)

        return decorated

__call__(f)

Thread-sichere Ausf├╝hrung einer Funktion oder Methode.

Quellcode in ultralytics/utils/__init__.py
def __call__(self, f):
    """Run thread-safe execution of function or method."""
    from functools import wraps

    @wraps(f)
    def decorated(*args, **kwargs):
        """Applies thread-safety to the decorated function or method."""
        with self.lock:
            return f(*args, **kwargs)

    return decorated

__init__()

Initialisiert die Decorator-Klasse f├╝r die thread-sichere Ausf├╝hrung einer Funktion oder Methode.

Quellcode in ultralytics/utils/__init__.py
def __init__(self):
    """Initializes the decorator class for thread-safe execution of a function or method."""
    self.lock = threading.Lock()



ultralytics.utils.TryExcept

Basen: ContextDecorator

Ultralytics TryExcept-Klasse. Verwende als @TryExcept() Dekorator oder 'with TryExcept():' Kontextmanager.

Beispiele:

Als Dekorateur:

>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>>    # Function logic here
>>>     pass

Als Kontextmanager:

>>> with TryExcept(msg="Error occurred in block", verbose=True):
>>>     # Code block here
>>>     pass
Quellcode in ultralytics/utils/__init__.py
class TryExcept(contextlib.ContextDecorator):
    """
    Ultralytics TryExcept class. Use as @TryExcept() decorator or 'with TryExcept():' context manager.

    Examples:
        As a decorator:
        >>> @TryExcept(msg="Error occurred in func", verbose=True)
        >>> def func():
        >>>    # Function logic here
        >>>     pass

        As a context manager:
        >>> with TryExcept(msg="Error occurred in block", verbose=True):
        >>>     # Code block here
        >>>     pass
    """

    def __init__(self, msg="", verbose=True):
        """Initialize TryExcept class with optional message and verbosity settings."""
        self.msg = msg
        self.verbose = verbose

    def __enter__(self):
        """Executes when entering TryExcept context, initializes instance."""
        pass

    def __exit__(self, exc_type, value, traceback):
        """Defines behavior when exiting a 'with' block, prints error message if necessary."""
        if self.verbose and value:
            print(emojis(f"{self.msg}{': ' if self.msg else ''}{value}"))
        return True

__enter__()

Wird beim Eintritt in den TryExcept-Kontext ausgef├╝hrt und initialisiert die Instanz.

Quellcode in ultralytics/utils/__init__.py
def __enter__(self):
    """Executes when entering TryExcept context, initializes instance."""
    pass

__exit__(exc_type, value, traceback)

Legt das Verhalten beim Verlassen eines "with"-Blocks fest und gibt ggf. eine Fehlermeldung aus.

Quellcode in ultralytics/utils/__init__.py
def __exit__(self, exc_type, value, traceback):
    """Defines behavior when exiting a 'with' block, prints error message if necessary."""
    if self.verbose and value:
        print(emojis(f"{self.msg}{': ' if self.msg else ''}{value}"))
    return True

__init__(msg='', verbose=True)

Initialisiere die TryExcept-Klasse mit optionalen Nachrichten- und Verbosity-Einstellungen.

Quellcode in ultralytics/utils/__init__.py
def __init__(self, msg="", verbose=True):
    """Initialize TryExcept class with optional message and verbosity settings."""
    self.msg = msg
    self.verbose = verbose



ultralytics.utils.Retry

Basen: ContextDecorator

Wiederholungsklasse f├╝r die Funktionsausf├╝hrung mit exponentiellem Backoff.

Kann als Dekorator oder als Kontextmanager verwendet werden, um eine Funktion oder einen Codeblock bei Ausnahmen bis zu einer Anzahl von Wiederholungen mit einer exponentiell ansteigenden Verz├Âgerung zwischen den Wiederholungen.

Beispiele:

Beispiel f├╝r die Verwendung als Dekorator:

>>> @Retry(times=3, delay=2)
>>> def test_func():
>>>     # Replace with function logic that may raise exceptions
>>>     return True

Beispiel f├╝r die Verwendung als Kontextmanager:

>>> with Retry(times=3, delay=2):
>>>     # Replace with code block that may raise exceptions
>>>     pass
Quellcode in ultralytics/utils/__init__.py
class Retry(contextlib.ContextDecorator):
    """
    Retry class for function execution with exponential backoff.

    Can be used as a decorator or a context manager to retry a function or block of code on exceptions, up to a
    specified number of times with an exponentially increasing delay between retries.

    Examples:
        Example usage as a decorator:
        >>> @Retry(times=3, delay=2)
        >>> def test_func():
        >>>     # Replace with function logic that may raise exceptions
        >>>     return True

        Example usage as a context manager:
        >>> with Retry(times=3, delay=2):
        >>>     # Replace with code block that may raise exceptions
        >>>     pass
    """

    def __init__(self, times=3, delay=2):
        """Initialize Retry class with specified number of retries and delay."""
        self.times = times
        self.delay = delay
        self._attempts = 0

    def __call__(self, func):
        """Decorator implementation for Retry with exponential backoff."""

        def wrapped_func(*args, **kwargs):
            """Applies retries to the decorated function or method."""
            self._attempts = 0
            while self._attempts < self.times:
                try:
                    return func(*args, **kwargs)
                except Exception as e:
                    self._attempts += 1
                    print(f"Retry {self._attempts}/{self.times} failed: {e}")
                    if self._attempts >= self.times:
                        raise e
                    time.sleep(self.delay * (2**self._attempts))  # exponential backoff delay

        return wrapped_func

    def __enter__(self):
        """Enter the runtime context related to this object."""
        self._attempts = 0

    def __exit__(self, exc_type, exc_value, traceback):
        """Exit the runtime context related to this object with exponential backoff."""
        if exc_type is not None:
            self._attempts += 1
            if self._attempts < self.times:
                print(f"Retry {self._attempts}/{self.times} failed: {exc_value}")
                time.sleep(self.delay * (2**self._attempts))  # exponential backoff delay
                return True  # Suppresses the exception and retries
        return False  # Re-raises the exception if retries are exhausted

__call__(func)

Decorator-Implementierung f├╝r Retry mit exponentiellem Backoff.

Quellcode in ultralytics/utils/__init__.py
def __call__(self, func):
    """Decorator implementation for Retry with exponential backoff."""

    def wrapped_func(*args, **kwargs):
        """Applies retries to the decorated function or method."""
        self._attempts = 0
        while self._attempts < self.times:
            try:
                return func(*args, **kwargs)
            except Exception as e:
                self._attempts += 1
                print(f"Retry {self._attempts}/{self.times} failed: {e}")
                if self._attempts >= self.times:
                    raise e
                time.sleep(self.delay * (2**self._attempts))  # exponential backoff delay

    return wrapped_func

__enter__()

Gib den Laufzeitkontext ein, der sich auf dieses Objekt bezieht.

Quellcode in ultralytics/utils/__init__.py
def __enter__(self):
    """Enter the runtime context related to this object."""
    self._attempts = 0

__exit__(exc_type, exc_value, traceback)

Beende den Laufzeitkontext f├╝r dieses Objekt mit exponentiellem Backoff.

Quellcode in ultralytics/utils/__init__.py
def __exit__(self, exc_type, exc_value, traceback):
    """Exit the runtime context related to this object with exponential backoff."""
    if exc_type is not None:
        self._attempts += 1
        if self._attempts < self.times:
            print(f"Retry {self._attempts}/{self.times} failed: {exc_value}")
            time.sleep(self.delay * (2**self._attempts))  # exponential backoff delay
            return True  # Suppresses the exception and retries
    return False  # Re-raises the exception if retries are exhausted

__init__(times=3, delay=2)

Initialisiere die Retry-Klasse mit der angegebenen Anzahl von Wiederholungen und der Verz├Âgerung.

Quellcode in ultralytics/utils/__init__.py
def __init__(self, times=3, delay=2):
    """Initialize Retry class with specified number of retries and delay."""
    self.times = times
    self.delay = delay
    self._attempts = 0



ultralytics.utils.SettingsManager

Basen: dict

Verwaltet die Ultralytics Einstellungen, die in einer YAML-Datei gespeichert sind.

Parameter:

Name Typ Beschreibung Standard
file str | Path

Pfad zur Ultralytics settings YAML-Datei. Der Standardwert ist USER_CONFIG_DIR / 'settings.yaml'.

SETTINGS_YAML
version str

Version der Einstellungen. Wenn die lokale Version nicht ├╝bereinstimmt, werden die neuen Standardeinstellungen gespeichert.

'0.0.4'
Quellcode in ultralytics/utils/__init__.py
class SettingsManager(dict):
    """
    Manages Ultralytics settings stored in a YAML file.

    Args:
        file (str | Path): Path to the Ultralytics settings YAML file. Default is USER_CONFIG_DIR / 'settings.yaml'.
        version (str): Settings version. In case of local version mismatch, new default settings will be saved.
    """

    def __init__(self, file=SETTINGS_YAML, version="0.0.4"):
        """Initialize the SettingsManager with default settings, load and validate current settings from the YAML
        file.
        """
        import copy
        import hashlib

        from ultralytics.utils.checks import check_version
        from ultralytics.utils.torch_utils import torch_distributed_zero_first

        git_dir = get_git_dir()
        root = git_dir or Path()
        datasets_root = (root.parent if git_dir and is_dir_writeable(root.parent) else root).resolve()

        self.file = Path(file)
        self.version = version
        self.defaults = {
            "settings_version": version,
            "datasets_dir": str(datasets_root / "datasets"),
            "weights_dir": str(root / "weights"),
            "runs_dir": str(root / "runs"),
            "uuid": hashlib.sha256(str(uuid.getnode()).encode()).hexdigest(),
            "sync": True,
            "api_key": "",
            "openai_api_key": "",
            "clearml": True,  # integrations
            "comet": True,
            "dvc": True,
            "hub": True,
            "mlflow": True,
            "neptune": True,
            "raytune": True,
            "tensorboard": True,
            "wandb": True,
        }

        super().__init__(copy.deepcopy(self.defaults))

        with torch_distributed_zero_first(RANK):
            if not self.file.exists():
                self.save()

            self.load()
            correct_keys = self.keys() == self.defaults.keys()
            correct_types = all(type(a) is type(b) for a, b in zip(self.values(), self.defaults.values()))
            correct_version = check_version(self["settings_version"], self.version)
            if not (correct_keys and correct_types and correct_version):
                LOGGER.warning(
                    "WARNING ÔÜá´ŞĆ Ultralytics settings reset to default values. This may be due to a possible problem "
                    "with your settings or a recent ultralytics package update. "
                    f"\nView settings with 'yolo settings' or at '{self.file}'"
                    "\nUpdate settings with 'yolo settings key=value', i.e. 'yolo settings runs_dir=path/to/dir'."
                )
                self.reset()

    def load(self):
        """Loads settings from the YAML file."""
        super().update(yaml_load(self.file))

    def save(self):
        """Saves the current settings to the YAML file."""
        yaml_save(self.file, dict(self))

    def update(self, *args, **kwargs):
        """Updates a setting value in the current settings."""
        super().update(*args, **kwargs)
        self.save()

    def reset(self):
        """Resets the settings to default and saves them."""
        self.clear()
        self.update(self.defaults)
        self.save()

__init__(file=SETTINGS_YAML, version='0.0.4')

Initialisiere den SettingsManager mit den Standardeinstellungen, lade und validiere die aktuellen Einstellungen aus der YAML Datei.

Quellcode in ultralytics/utils/__init__.py
def __init__(self, file=SETTINGS_YAML, version="0.0.4"):
    """Initialize the SettingsManager with default settings, load and validate current settings from the YAML
    file.
    """
    import copy
    import hashlib

    from ultralytics.utils.checks import check_version
    from ultralytics.utils.torch_utils import torch_distributed_zero_first

    git_dir = get_git_dir()
    root = git_dir or Path()
    datasets_root = (root.parent if git_dir and is_dir_writeable(root.parent) else root).resolve()

    self.file = Path(file)
    self.version = version
    self.defaults = {
        "settings_version": version,
        "datasets_dir": str(datasets_root / "datasets"),
        "weights_dir": str(root / "weights"),
        "runs_dir": str(root / "runs"),
        "uuid": hashlib.sha256(str(uuid.getnode()).encode()).hexdigest(),
        "sync": True,
        "api_key": "",
        "openai_api_key": "",
        "clearml": True,  # integrations
        "comet": True,
        "dvc": True,
        "hub": True,
        "mlflow": True,
        "neptune": True,
        "raytune": True,
        "tensorboard": True,
        "wandb": True,
    }

    super().__init__(copy.deepcopy(self.defaults))

    with torch_distributed_zero_first(RANK):
        if not self.file.exists():
            self.save()

        self.load()
        correct_keys = self.keys() == self.defaults.keys()
        correct_types = all(type(a) is type(b) for a, b in zip(self.values(), self.defaults.values()))
        correct_version = check_version(self["settings_version"], self.version)
        if not (correct_keys and correct_types and correct_version):
            LOGGER.warning(
                "WARNING ÔÜá´ŞĆ Ultralytics settings reset to default values. This may be due to a possible problem "
                "with your settings or a recent ultralytics package update. "
                f"\nView settings with 'yolo settings' or at '{self.file}'"
                "\nUpdate settings with 'yolo settings key=value', i.e. 'yolo settings runs_dir=path/to/dir'."
            )
            self.reset()

load()

L├Ądt die Einstellungen aus der YAML-Datei.

Quellcode in ultralytics/utils/__init__.py
def load(self):
    """Loads settings from the YAML file."""
    super().update(yaml_load(self.file))

reset()

Setzt die Einstellungen auf die Standardwerte zur├╝ck und speichert sie.

Quellcode in ultralytics/utils/__init__.py
def reset(self):
    """Resets the settings to default and saves them."""
    self.clear()
    self.update(self.defaults)
    self.save()

save()

Speichert die aktuellen Einstellungen in der YAML-Datei.

Quellcode in ultralytics/utils/__init__.py
def save(self):
    """Saves the current settings to the YAML file."""
    yaml_save(self.file, dict(self))

update(*args, **kwargs)

Aktualisiert einen Einstellungswert in den aktuellen Einstellungen.

Quellcode in ultralytics/utils/__init__.py
def update(self, *args, **kwargs):
    """Updates a setting value in the current settings."""
    super().update(*args, **kwargs)
    self.save()



ultralytics.utils.plt_settings(rcparams=None, backend='Agg')

Decorator zum tempor├Ąren Setzen von rc-Parametern und des Backends f├╝r eine Plotting-Funktion.

Beispiel

decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):

Parameter:

Name Typ Beschreibung Standard
rcparams dict

W├Ârterbuch der zu setzenden rc-Parameter.

None
backend str

Name des zu verwendenden Backends. Der Standardwert ist "Agg".

'Agg'

Retouren:

Typ Beschreibung
Callable

Dekorierte Funktion mit tempor├Ąr gesetzten rc-Parametern und Backend. Dieser Decorator kann auf jede Funktion angewendet werden, die f├╝r ihre Ausf├╝hrung bestimmte matplotlib rc-Parameter und ein Backend ben├Âtigt.

Quellcode in ultralytics/utils/__init__.py
def plt_settings(rcparams=None, backend="Agg"):
    """
    Decorator to temporarily set rc parameters and the backend for a plotting function.

    Example:
        decorator: @plt_settings({"font.size": 12})
        context manager: with plt_settings({"font.size": 12}):

    Args:
        rcparams (dict): Dictionary of rc parameters to set.
        backend (str, optional): Name of the backend to use. Defaults to 'Agg'.

    Returns:
        (Callable): Decorated function with temporarily set rc parameters and backend. This decorator can be
            applied to any function that needs to have specific matplotlib rc parameters and backend for its execution.
    """

    if rcparams is None:
        rcparams = {"font.size": 11}

    def decorator(func):
        """Decorator to apply temporary rc parameters and backend to a function."""

        def wrapper(*args, **kwargs):
            """Sets rc parameters and backend, calls the original function, and restores the settings."""
            original_backend = plt.get_backend()
            if backend.lower() != original_backend.lower():
                plt.close("all")  # auto-close()ing of figures upon backend switching is deprecated since 3.8
                plt.switch_backend(backend)

            with plt.rc_context(rcparams):
                result = func(*args, **kwargs)

            if backend != original_backend:
                plt.close("all")
                plt.switch_backend(original_backend)
            return result

        return wrapper

    return decorator



ultralytics.utils.set_logging(name=LOGGING_NAME, verbose=True)

Richtet die Protokollierung f├╝r den angegebenen Namen mit Unterst├╝tzung der UTF-8-Kodierung ein.

Quellcode in ultralytics/utils/__init__.py
def set_logging(name=LOGGING_NAME, verbose=True):
    """Sets up logging for the given name with UTF-8 encoding support."""
    level = logging.INFO if verbose and RANK in {-1, 0} else logging.ERROR  # rank in world for Multi-GPU trainings

    # Configure the console (stdout) encoding to UTF-8
    formatter = logging.Formatter("%(message)s")  # Default formatter
    if WINDOWS and sys.stdout.encoding != "utf-8":
        try:
            if hasattr(sys.stdout, "reconfigure"):
                sys.stdout.reconfigure(encoding="utf-8")
            elif hasattr(sys.stdout, "buffer"):
                import io

                sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding="utf-8")
            else:
                sys.stdout.encoding = "utf-8"
        except Exception as e:
            print(f"Creating custom formatter for non UTF-8 environments due to {e}")

            class CustomFormatter(logging.Formatter):
                def format(self, record):
                    """Sets up logging with UTF-8 encoding and configurable verbosity."""
                    return emojis(super().format(record))

            formatter = CustomFormatter("%(message)s")  # Use CustomFormatter to eliminate UTF-8 output as last recourse

    # Create and configure the StreamHandler
    stream_handler = logging.StreamHandler(sys.stdout)
    stream_handler.setFormatter(formatter)
    stream_handler.setLevel(level)

    logger = logging.getLogger(name)
    logger.setLevel(level)
    logger.addHandler(stream_handler)
    logger.propagate = False
    return logger



ultralytics.utils.emojis(string='')

Gibt die plattformabh├Ąngige emoji-sichere Version von string zur├╝ck.

Quellcode in ultralytics/utils/__init__.py
def emojis(string=""):
    """Return platform-dependent emoji-safe version of string."""
    return string.encode().decode("ascii", "ignore") if WINDOWS else string



ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')

Speichere YAML-Daten in einer Datei.

Parameter:

Name Typ Beschreibung Standard
file str

Dateiname. Der Standard ist "data.yaml".

'data.yaml'
data dict

Zu speichernde Daten im YAML-Format.

None
header str

YAML-Header zum Hinzuf├╝gen.

''

Retouren:

Typ Beschreibung
None

Die Daten werden in der angegebenen Datei gespeichert.

Quellcode in ultralytics/utils/__init__.py
def yaml_save(file="data.yaml", data=None, header=""):
    """
    Save YAML data to a file.

    Args:
        file (str, optional): File name. Default is 'data.yaml'.
        data (dict): Data to save in YAML format.
        header (str, optional): YAML header to add.

    Returns:
        (None): Data is saved to the specified file.
    """
    if data is None:
        data = {}
    file = Path(file)
    if not file.parent.exists():
        # Create parent directories if they don't exist
        file.parent.mkdir(parents=True, exist_ok=True)

    # Convert Path objects to strings
    valid_types = int, float, str, bool, list, tuple, dict, type(None)
    for k, v in data.items():
        if not isinstance(v, valid_types):
            data[k] = str(v)

    # Dump data to file in YAML format
    with open(file, "w", errors="ignore", encoding="utf-8") as f:
        if header:
            f.write(header)
        yaml.safe_dump(data, f, sort_keys=False, allow_unicode=True)



ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)

Lade YAML-Daten aus einer Datei.

Parameter:

Name Typ Beschreibung Standard
file str

Dateiname. Der Standard ist "data.yaml".

'data.yaml'
append_filename bool

F├╝gt den YAML-Dateinamen in das YAML-W├Ârterbuch ein. Standard ist False.

False

Retouren:

Typ Beschreibung
dict

YAML-Daten und Dateiname.

Quellcode in ultralytics/utils/__init__.py
def yaml_load(file="data.yaml", append_filename=False):
    """
    Load YAML data from a file.

    Args:
        file (str, optional): File name. Default is 'data.yaml'.
        append_filename (bool): Add the YAML filename to the YAML dictionary. Default is False.

    Returns:
        (dict): YAML data and file name.
    """
    assert Path(file).suffix in (".yaml", ".yml"), f"Attempting to load non-YAML file {file} with yaml_load()"
    with open(file, errors="ignore", encoding="utf-8") as f:
        s = f.read()  # string

        # Remove special characters
        if not s.isprintable():
            s = re.sub(r"[^\x09\x0A\x0D\x20-\x7E\x85\xA0-\uD7FF\uE000-\uFFFD\U00010000-\U0010ffff]+", "", s)

        # Add YAML filename to dict and return
        data = yaml.safe_load(s) or {}  # always return a dict (yaml.safe_load() may return None for empty files)
        if append_filename:
            data["yaml_file"] = str(file)
        return data



ultralytics.utils.yaml_print(yaml_file)

Pretty gibt eine YAML-Datei oder ein YAML-formatiertes W├Ârterbuch aus.

Parameter:

Name Typ Beschreibung Standard
yaml_file Union[str, Path, dict]

Der Dateipfad der YAML-Datei oder eines YAML-formatierten W├Ârterbuchs.

erforderlich

Retouren:

Typ Beschreibung
None

(Keine)

Quellcode in ultralytics/utils/__init__.py
def yaml_print(yaml_file: Union[str, Path, dict]) -> None:
    """
    Pretty prints a YAML file or a YAML-formatted dictionary.

    Args:
        yaml_file: The file path of the YAML file or a YAML-formatted dictionary.

    Returns:
        (None)
    """
    yaml_dict = yaml_load(yaml_file) if isinstance(yaml_file, (str, Path)) else yaml_file
    dump = yaml.dump(yaml_dict, sort_keys=False, allow_unicode=True)
    LOGGER.info(f"Printing '{colorstr('bold', 'black', yaml_file)}'\n\n{dump}")



ultralytics.utils.is_ubuntu()

Pr├╝fe, ob das Betriebssystem Ubuntu ist.

Retouren:

Typ Beschreibung
bool

True, wenn das Betriebssystem Ubuntu ist, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_ubuntu() -> bool:
    """
    Check if the OS is Ubuntu.

    Returns:
        (bool): True if OS is Ubuntu, False otherwise.
    """
    with contextlib.suppress(FileNotFoundError):
        with open("/etc/os-release") as f:
            return "ID=ubuntu" in f.read()
    return False



ultralytics.utils.is_colab()

Pr├╝fe, ob das aktuelle Skript in einem Google Colab-Notizbuch ausgef├╝hrt wird.

Retouren:

Typ Beschreibung
bool

True, wenn es in einem Colab-Notebook l├Ąuft, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_colab():
    """
    Check if the current script is running inside a Google Colab notebook.

    Returns:
        (bool): True if running inside a Colab notebook, False otherwise.
    """
    return "COLAB_RELEASE_TAG" in os.environ or "COLAB_BACKEND_VERSION" in os.environ



ultralytics.utils.is_kaggle()

Pr├╝fe, ob das aktuelle Skript in einem Kaggle-Kernel l├Ąuft.

Retouren:

Typ Beschreibung
bool

True, wenn es in einem Kaggle-Kernel l├Ąuft, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_kaggle():
    """
    Check if the current script is running inside a Kaggle kernel.

    Returns:
        (bool): True if running inside a Kaggle kernel, False otherwise.
    """
    return os.environ.get("PWD") == "/kaggle/working" and os.environ.get("KAGGLE_URL_BASE") == "https://www.kaggle.com"



ultralytics.utils.is_jupyter()

├ťberpr├╝fe, ob das aktuelle Skript in einem Jupyter Notebook l├Ąuft. Verifiziert auf Colab, Jupyterlab, Kaggle, Paperspace.

Retouren:

Typ Beschreibung
bool

True, wenn es in einem Jupyter Notebook l├Ąuft, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_jupyter():
    """
    Check if the current script is running inside a Jupyter Notebook. Verified on Colab, Jupyterlab, Kaggle, Paperspace.

    Returns:
        (bool): True if running inside a Jupyter Notebook, False otherwise.
    """
    with contextlib.suppress(Exception):
        from IPython import get_ipython

        return get_ipython() is not None
    return False



ultralytics.utils.is_docker()

Stelle fest, ob das Skript in einem Docker-Container l├Ąuft.

Retouren:

Typ Beschreibung
bool

True, wenn das Skript in einem Docker-Container l├Ąuft, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_docker() -> bool:
    """
    Determine if the script is running inside a Docker container.

    Returns:
        (bool): True if the script is running inside a Docker container, False otherwise.
    """
    file = Path("/proc/self/cgroup")
    if file.exists():
        with open(file) as f:
            return "docker" in f.read()
    else:
        return False



ultralytics.utils.is_online()

├ťberpr├╝fe die Internetverbindung, indem du versuchst, dich mit einem bekannten Online-Host zu verbinden.

Retouren:

Typ Beschreibung
bool

True, wenn die Verbindung erfolgreich ist, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_online() -> bool:
    """
    Check internet connectivity by attempting to connect to a known online host.

    Returns:
        (bool): True if connection is successful, False otherwise.
    """
    import socket

    for host in "1.1.1.1", "8.8.8.8", "223.5.5.5":  # Cloudflare, Google, AliDNS:
        try:
            test_connection = socket.create_connection(address=(host, 53), timeout=2)
        except (socket.timeout, socket.gaierror, OSError):
            continue
        else:
            # If the connection was successful, close it to avoid a ResourceWarning
            test_connection.close()
            return True
    return False



ultralytics.utils.is_pip_package(filepath=__name__)

Ermittelt, ob die Datei im angegebenen Dateipfad Teil eines pip-Pakets ist.

Parameter:

Name Typ Beschreibung Standard
filepath str

Der zu pr├╝fende Dateipfad.

__name__

Retouren:

Typ Beschreibung
bool

True, wenn die Datei Teil eines Pip-Pakets ist, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_pip_package(filepath: str = __name__) -> bool:
    """
    Determines if the file at the given filepath is part of a pip package.

    Args:
        filepath (str): The filepath to check.

    Returns:
        (bool): True if the file is part of a pip package, False otherwise.
    """
    import importlib.util

    # Get the spec for the module
    spec = importlib.util.find_spec(filepath)

    # Return whether the spec is not None and the origin is not None (indicating it is a package)
    return spec is not None and spec.origin is not None



ultralytics.utils.is_dir_writeable(dir_path)

Pr├╝fe, ob ein Verzeichnis beschreibbar ist.

Parameter:

Name Typ Beschreibung Standard
dir_path str | Path

Der Pfad zum Verzeichnis.

erforderlich

Retouren:

Typ Beschreibung
bool

True, wenn das Verzeichnis beschreibbar ist, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_dir_writeable(dir_path: Union[str, Path]) -> bool:
    """
    Check if a directory is writeable.

    Args:
        dir_path (str | Path): The path to the directory.

    Returns:
        (bool): True if the directory is writeable, False otherwise.
    """
    return os.access(str(dir_path), os.W_OK)



ultralytics.utils.is_pytest_running()

Ermittelt, ob pytest gerade l├Ąuft oder nicht.

Retouren:

Typ Beschreibung
bool

True, wenn pytest l├Ąuft, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_pytest_running():
    """
    Determines whether pytest is currently running or not.

    Returns:
        (bool): True if pytest is running, False otherwise.
    """
    return ("PYTEST_CURRENT_TEST" in os.environ) or ("pytest" in sys.modules) or ("pytest" in Path(sys.argv[0]).stem)



ultralytics.utils.is_github_action_running()

Stelle fest, ob die aktuelle Umgebung ein GitHub Actions Runner ist.

Retouren:

Typ Beschreibung
bool

True, wenn die aktuelle Umgebung ein GitHub Actions Runner ist, sonst False.

Quellcode in ultralytics/utils/__init__.py
def is_github_action_running() -> bool:
    """
    Determine if the current environment is a GitHub Actions runner.

    Returns:
        (bool): True if the current environment is a GitHub Actions runner, False otherwise.
    """
    return "GITHUB_ACTIONS" in os.environ and "GITHUB_WORKFLOW" in os.environ and "RUNNER_OS" in os.environ



ultralytics.utils.is_git_dir()

Ermittelt, ob die aktuelle Datei Teil eines Git-Repositorys ist. Wenn die aktuelle Datei nicht Teil eines Git Repository ist, wird None zur├╝ckgegeben.

Retouren:

Typ Beschreibung
bool

Wahr, wenn die aktuelle Datei Teil eines Git-Repositorys ist.

Quellcode in ultralytics/utils/__init__.py
def is_git_dir():
    """
    Determines whether the current file is part of a git repository. If the current file is not part of a git
    repository, returns None.

    Returns:
        (bool): True if current file is part of a git repository.
    """
    return get_git_dir() is not None



ultralytics.utils.get_git_dir()

Ermittelt, ob die aktuelle Datei Teil eines Git-Repositorys ist, und gibt, falls ja, das Stammverzeichnis des Repositorys zur├╝ck. Wenn die aktuelle Datei nicht Teil eines Git-Repositorys ist, wird None zur├╝ckgegeben.

Retouren:

Typ Beschreibung
Path | None

Git-Stammverzeichnis, wenn es gefunden wurde, oder None, wenn es nicht gefunden wurde.

Quellcode in ultralytics/utils/__init__.py
def get_git_dir():
    """
    Determines whether the current file is part of a git repository and if so, returns the repository root directory. If
    the current file is not part of a git repository, returns None.

    Returns:
        (Path | None): Git root directory if found or None if not found.
    """
    for d in Path(__file__).parents:
        if (d / ".git").is_dir():
            return d



ultralytics.utils.get_git_origin_url()

Ruft die Ursprungs-URL eines Git-Repositorys ab.

Retouren:

Typ Beschreibung
str | None

Die Ursprungs-URL des Git-Repositorys oder Keine, wenn es sich nicht um ein Git-Verzeichnis handelt.

Quellcode in ultralytics/utils/__init__.py
def get_git_origin_url():
    """
    Retrieves the origin URL of a git repository.

    Returns:
        (str | None): The origin URL of the git repository or None if not git directory.
    """
    if is_git_dir():
        with contextlib.suppress(subprocess.CalledProcessError):
            origin = subprocess.check_output(["git", "config", "--get", "remote.origin.url"])
            return origin.decode().strip()



ultralytics.utils.get_git_branch()

Gibt den Namen des aktuellen Git-Zweigs zur├╝ck. Wenn kein Git-Repository vorhanden ist, wird None zur├╝ckgegeben.

Retouren:

Typ Beschreibung
str | None

Der Name des aktuellen Git-Zweigs oder None, wenn es sich nicht um ein Git-Verzeichnis handelt.

Quellcode in ultralytics/utils/__init__.py
def get_git_branch():
    """
    Returns the current git branch name. If not in a git repository, returns None.

    Returns:
        (str | None): The current git branch name or None if not a git directory.
    """
    if is_git_dir():
        with contextlib.suppress(subprocess.CalledProcessError):
            origin = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
            return origin.decode().strip()



ultralytics.utils.get_default_args(func)

Gibt ein W├Ârterbuch mit Standardargumenten f├╝r eine Funktion zur├╝ck.

Parameter:

Name Typ Beschreibung Standard
func callable

Die zu pr├╝fende Funktion.

erforderlich

Retouren:

Typ Beschreibung
dict

Ein W├Ârterbuch, in dem jeder Schl├╝ssel ein Parametername und jeder Wert der Standardwert dieses Parameters ist.

Quellcode in ultralytics/utils/__init__.py
def get_default_args(func):
    """
    Returns a dictionary of default arguments for a function.

    Args:
        func (callable): The function to inspect.

    Returns:
        (dict): A dictionary where each key is a parameter name, and each value is the default value of that parameter.
    """
    signature = inspect.signature(func)
    return {k: v.default for k, v in signature.parameters.items() if v.default is not inspect.Parameter.empty}



ultralytics.utils.get_ubuntu_version()

Rufe die Ubuntu-Version ab, wenn das Betriebssystem Ubuntu ist.

Retouren:

Typ Beschreibung
str

Ubuntu-Version oder Keine, wenn du kein Ubuntu-Betriebssystem hast.

Quellcode in ultralytics/utils/__init__.py
def get_ubuntu_version():
    """
    Retrieve the Ubuntu version if the OS is Ubuntu.

    Returns:
        (str): Ubuntu version or None if not an Ubuntu OS.
    """
    if is_ubuntu():
        with contextlib.suppress(FileNotFoundError, AttributeError):
            with open("/etc/os-release") as f:
                return re.search(r'VERSION_ID="(\d+\.\d+)"', f.read())[1]



ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')

Gibt das entsprechende Konfigurationsverzeichnis zur├╝ck, das auf dem Betriebssystem der Umgebung basiert.

Parameter:

Name Typ Beschreibung Standard
sub_dir str

Der Name des zu erstellenden Unterverzeichnisses.

'Ultralytics'

Retouren:

Typ Beschreibung
Path

Der Pfad zum Verzeichnis der Benutzerkonfiguration.

Quellcode in ultralytics/utils/__init__.py
def get_user_config_dir(sub_dir="Ultralytics"):
    """
    Return the appropriate config directory based on the environment operating system.

    Args:
        sub_dir (str): The name of the subdirectory to create.

    Returns:
        (Path): The path to the user config directory.
    """
    if WINDOWS:
        path = Path.home() / "AppData" / "Roaming" / sub_dir
    elif MACOS:  # macOS
        path = Path.home() / "Library" / "Application Support" / sub_dir
    elif LINUX:
        path = Path.home() / ".config" / sub_dir
    else:
        raise ValueError(f"Unsupported operating system: {platform.system()}")

    # GCP and AWS lambda fix, only /tmp is writeable
    if not is_dir_writeable(path.parent):
        LOGGER.warning(
            f"WARNING ÔÜá´ŞĆ user config directory '{path}' is not writeable, defaulting to '/tmp' or CWD."
            "Alternatively you can define a YOLO_CONFIG_DIR environment variable for this path."
        )
        path = Path("/tmp") / sub_dir if is_dir_writeable("/tmp") else Path().cwd() / sub_dir

    # Create the subdirectory if it does not exist
    path.mkdir(parents=True, exist_ok=True)

    return path



ultralytics.utils.colorstr(*input)

F├Ąrbt eine Zeichenkette basierend auf den angegebenen Farb- und Stilargumenten. Verwendet ANSI-Escape-Codes. Siehe https://en.wikipedia.org/wiki/ANSI_escape_code f├╝r weitere Details.

Diese Funktion kann auf zwei Arten aufgerufen werden
  • colorstr('color', 'style', 'your string')
  • colorstr('dein String')

In der zweiten Form werden standardm├Ą├čig "blau" und "fett" verwendet.

Parameter:

Name Typ Beschreibung Standard
*input str

Eine Folge von Strings, wobei die ersten n-1 Strings Farb- und Stilargumente sind, und die letzte Zeichenkette diejenige ist, die gef├Ąrbt werden soll.

()
Unterst├╝tzte Farben und Stile

Grundfarben: 'schwarz', 'rot', 'gr├╝n', 'gelb', 'blau', 'magenta', 'cyan', 'wei├č' Leuchtende Farben: 'bright_black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white' Sonstiges: 'end', 'bold', 'underline'

Retouren:

Typ Beschreibung
str

Der Eingabestring wird mit ANSI-Escape-Codes f├╝r die angegebene Farbe und den Stil umbrochen.

Beispiele:

>>> colorstr('blue', 'bold', 'hello world')
>>> 'hello world'
Quellcode in ultralytics/utils/__init__.py
def colorstr(*input):
    """
    Colors a string based on the provided color and style arguments. Utilizes ANSI escape codes.
    See https://en.wikipedia.org/wiki/ANSI_escape_code for more details.

    This function can be called in two ways:
        - colorstr('color', 'style', 'your string')
        - colorstr('your string')

    In the second form, 'blue' and 'bold' will be applied by default.

    Args:
        *input (str): A sequence of strings where the first n-1 strings are color and style arguments,
                      and the last string is the one to be colored.

    Supported Colors and Styles:
        Basic Colors: 'black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white'
        Bright Colors: 'bright_black', 'bright_red', 'bright_green', 'bright_yellow',
                       'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white'
        Misc: 'end', 'bold', 'underline'

    Returns:
        (str): The input string wrapped with ANSI escape codes for the specified color and style.

    Examples:
        >>> colorstr('blue', 'bold', 'hello world')
        >>> '\033[34m\033[1mhello world\033[0m'
    """
    *args, string = input if len(input) > 1 else ("blue", "bold", input[0])  # color arguments, string
    colors = {
        "black": "\033[30m",  # basic colors
        "red": "\033[31m",
        "green": "\033[32m",
        "yellow": "\033[33m",
        "blue": "\033[34m",
        "magenta": "\033[35m",
        "cyan": "\033[36m",
        "white": "\033[37m",
        "bright_black": "\033[90m",  # bright colors
        "bright_red": "\033[91m",
        "bright_green": "\033[92m",
        "bright_yellow": "\033[93m",
        "bright_blue": "\033[94m",
        "bright_magenta": "\033[95m",
        "bright_cyan": "\033[96m",
        "bright_white": "\033[97m",
        "end": "\033[0m",  # misc
        "bold": "\033[1m",
        "underline": "\033[4m",
    }
    return "".join(colors[x] for x in args) + f"{string}" + colors["end"]



ultralytics.utils.remove_colorstr(input_string)

Entfernt ANSI-Escape-Codes aus einer Zeichenkette, sodass sie nicht mehr eingef├Ąrbt wird.

Parameter:

Name Typ Beschreibung Standard
input_string str

Der String, aus dem Farbe und Stil entfernt werden sollen.

erforderlich

Retouren:

Typ Beschreibung
str

Ein neuer String, bei dem alle ANSI-Escape-Codes entfernt wurden.

Beispiele:

>>> remove_colorstr(colorstr('blue', 'bold', 'hello world'))
>>> 'hello world'
Quellcode in ultralytics/utils/__init__.py
def remove_colorstr(input_string):
    """
    Removes ANSI escape codes from a string, effectively un-coloring it.

    Args:
        input_string (str): The string to remove color and style from.

    Returns:
        (str): A new string with all ANSI escape codes removed.

    Examples:
        >>> remove_colorstr(colorstr('blue', 'bold', 'hello world'))
        >>> 'hello world'
    """
    ansi_escape = re.compile(r"\x1B\[[0-9;]*[A-Za-z]")
    return ansi_escape.sub("", input_string)



ultralytics.utils.threaded(func)

Multithreadet eine Zielfunktion standardm├Ą├čig und gibt das Ergebnis des Threads oder der Funktion zur├╝ck.

Verwendung als @threaded Dekorator. Die Funktion wird in einem separaten Thread ausgef├╝hrt, es sei denn, es wird 'threaded=False' ├╝bergeben.

Quellcode in ultralytics/utils/__init__.py
def threaded(func):
    """
    Multi-threads a target function by default and returns the thread or function result.

    Use as @threaded decorator. The function runs in a separate thread unless 'threaded=False' is passed.
    """

    def wrapper(*args, **kwargs):
        """Multi-threads a given function based on 'threaded' kwarg and returns the thread or function result."""
        if kwargs.pop("threaded", True):  # run in thread
            thread = threading.Thread(target=func, args=args, kwargs=kwargs, daemon=True)
            thread.start()
            return thread
        else:
            return func(*args, **kwargs)

    return wrapper



ultralytics.utils.set_sentry()

Initialisiere das Sentry SDK f├╝r die Fehlerverfolgung und -meldung. Wird nur verwendet, wenn das Paket sentry_sdk installiert ist und sync=True in den Einstellungen. F├╝hre 'yolo settings' aus, um die YAML-Datei mit den Einstellungen anzuzeigen und zu aktualisieren.

Erforderliche Bedingungen, um Fehler zu senden (ALLE Bedingungen m├╝ssen erf├╝llt sein, sonst werden keine Fehler gemeldet): - sentry_sdk-Paket ist installiert - sync=True in den Einstellungen von YOLO - pytest wird nicht ausgef├╝hrt - l├Ąuft in einer pip-Paketinstallation - l├Ąuft in einem Nicht-Git-Verzeichnis - mit Rang -1 oder 0 ausgef├╝hrt wird - Online-Umgebung - CLI verwendet, um das Paket auszuf├╝hren (├╝berpr├╝ft mit 'yolo' als Name des Hauptbefehls CLI )

Die Funktion konfiguriert Sentry SDK au├čerdem so, dass es die Ausnahmen KeyboardInterrupt und FileNotFoundError Ausnahmen zu ignorieren und Ereignisse mit "out of memory" in der Ausnahmemeldung auszuschlie├čen.

Au├čerdem setzt die Funktion benutzerdefinierte Tags und Benutzerinformationen f├╝r Sentry-Ereignisse.

Quellcode in ultralytics/utils/__init__.py
def set_sentry():
    """
    Initialize the Sentry SDK for error tracking and reporting. Only used if sentry_sdk package is installed and
    sync=True in settings. Run 'yolo settings' to see and update settings YAML file.

    Conditions required to send errors (ALL conditions must be met or no errors will be reported):
        - sentry_sdk package is installed
        - sync=True in YOLO settings
        - pytest is not running
        - running in a pip package installation
        - running in a non-git directory
        - running with rank -1 or 0
        - online environment
        - CLI used to run package (checked with 'yolo' as the name of the main CLI command)

    The function also configures Sentry SDK to ignore KeyboardInterrupt and FileNotFoundError
    exceptions and to exclude events with 'out of memory' in their exception message.

    Additionally, the function sets custom tags and user information for Sentry events.
    """

    def before_send(event, hint):
        """
        Modify the event before sending it to Sentry based on specific exception types and messages.

        Args:
            event (dict): The event dictionary containing information about the error.
            hint (dict): A dictionary containing additional information about the error.

        Returns:
            dict: The modified event or None if the event should not be sent to Sentry.
        """
        if "exc_info" in hint:
            exc_type, exc_value, tb = hint["exc_info"]
            if exc_type in (KeyboardInterrupt, FileNotFoundError) or "out of memory" in str(exc_value):
                return None  # do not send event

        event["tags"] = {
            "sys_argv": sys.argv[0],
            "sys_argv_name": Path(sys.argv[0]).name,
            "install": "git" if is_git_dir() else "pip" if is_pip_package() else "other",
            "os": ENVIRONMENT,
        }
        return event

    if (
        SETTINGS["sync"]
        and RANK in (-1, 0)
        and Path(sys.argv[0]).name == "yolo"
        and not TESTS_RUNNING
        and ONLINE
        and is_pip_package()
        and not is_git_dir()
    ):
        # If sentry_sdk package is not installed then return and do not use Sentry
        try:
            import sentry_sdk  # noqa
        except ImportError:
            return

        sentry_sdk.init(
            dsn="https://5ff1556b71594bfea135ff0203a0d290@o4504521589325824.ingest.sentry.io/4504521592406016",
            debug=False,
            traces_sample_rate=1.0,
            release=__version__,
            environment="production",  # 'dev' or 'production'
            before_send=before_send,
            ignore_errors=[KeyboardInterrupt, FileNotFoundError],
        )
        sentry_sdk.set_user({"id": SETTINGS["uuid"]})  # SHA-256 anonymized UUID hash



ultralytics.utils.deprecation_warn(arg, new_arg, version=None)

Gib eine Verwerfungswarnung aus, wenn ein veraltetes Argument verwendet wird, und schlage ein aktualisiertes Argument vor.

Quellcode in ultralytics/utils/__init__.py
def deprecation_warn(arg, new_arg, version=None):
    """Issue a deprecation warning when a deprecated argument is used, suggesting an updated argument."""
    if not version:
        version = float(__version__[:3]) + 0.2  # deprecate after 2nd major release
    LOGGER.warning(
        f"WARNING ÔÜá´ŞĆ '{arg}' is deprecated and will be removed in 'ultralytics {version}' in the future. "
        f"Please use '{new_arg}' instead."
    )



ultralytics.utils.clean_url(url)

Entferne die Autorisierung aus der URL, d.h. https://url.com/file.txt?auth -> https://url.com/file.txt.

Quellcode in ultralytics/utils/__init__.py
def clean_url(url):
    """Strip auth from URL, i.e. https://url.com/file.txt?auth -> https://url.com/file.txt."""
    url = Path(url).as_posix().replace(":/", "://")  # Pathlib turns :// -> :/, as_posix() for Windows
    return urllib.parse.unquote(url).split("?")[0]  # '%2F' to '/', split https://url.com/file.txt?auth



ultralytics.utils.url2file(url)

Konvertiere die URL in einen Dateinamen, d.h. https://url.com/file.txt?auth -> file.txt.

Quellcode in ultralytics/utils/__init__.py
def url2file(url):
    """Convert URL to filename, i.e. https://url.com/file.txt?auth -> file.txt."""
    return Path(clean_url(url)).name





Erstellt am 2023-11-12, Aktualisiert am 2024-01-27
Autoren: glenn-jocher (7), Laughing-q (1)