انتقل إلى المحتوى

مرجع ل ultralytics/utils/__init__.py

ملاحظه

هذا الملف متاح في https://github.com/ultralytics/ultralytics/ نقطة / الرئيسية /ultralytics/utils/init.py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!



ultralytics.utils.TQDM

قواعد: tqdm

تقليد Ultralytics فئة TQDM مع وسيطات افتراضية مختلفة.

البارامترات:

اسم نوع وصف افتراضي
*args list

تم تمرير الحجج الموضعية إلى tqdm الأصلي.

()
**kwargs any

وسيطات الكلمات الرئيسية، مع تطبيق الإعدادات الافتراضية المخصصة.

{}
شفرة المصدر في 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 (any): 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)

تهيئة مخصص Ultralytics فئة TQDM مع وسيطات افتراضية مختلفة.

لاحظ أنه لا يزال من الممكن تجاوزها عند استدعاء TQDM.

شفرة المصدر في 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 هي فئة أساسية توفر تمثيلا مفيدا للسلسلة والإبلاغ عن الأخطاء والسمة طرق الوصول لتسهيل تصحيح الأخطاء والاستخدام.

شفرة المصدر في 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)

رسالة خطأ الوصول إلى السمة المخصصة مع معلومات مفيدة.

شفرة المصدر في 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__()

إرجاع تمثيل سلسلة قابل للقراءة آليا للكائن.

شفرة المصدر في ultralytics/utils/__init__.py
def __repr__(self):
    """Return a machine-readable string representation of the object."""
    return self.__str__()

__str__()

إرجاع تمثيل سلسلة يمكن للإنسان قراءته للكائن.

شفرة المصدر في 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

قواعد: SimpleNamespace

Ultralytics IterableSimpleNamespace هي فئة ملحق من SimpleNamespace تضيف وظائف قابلة للتكرار و تمكين الاستخدام مع dict () وللحلقات.

شفرة المصدر في 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)

رسالة خطأ الوصول إلى السمة المخصصة مع معلومات مفيدة.

شفرة المصدر في 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__()

إرجاع مكرر لأزواج قيم المفاتيح من سمات مساحة الاسم.

شفرة المصدر في 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__()

إرجاع تمثيل سلسلة يمكن للإنسان قراءته للكائن.

شفرة المصدر في 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)

إرجاع قيمة المفتاح المحدد إذا كان موجودا ؛ وإلا، فقم بإرجاع القيمة الافتراضية.

شفرة المصدر في 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

فئة ديكور لضمان التنفيذ الآمن للخيط لوظيفة أو طريقة. يمكن استخدام هذه الفئة كديكور للتأكد من أنه إذا تم استدعاء الوظيفة المزخرفة من مؤشرات ترابط متعددة ، فلن يتمكن سوى مؤشر ترابط واحد في كل مرة لتنفيذ الوظيفة.

سمات:

اسم نوع وصف
lock Lock

كائن قفل يستخدم لإدارة الوصول إلى الوظيفة المزخرفة.

مثل
from ultralytics.utils import ThreadingLocked

@ThreadingLocked()
def my_function():
    # Your code here
    pass
شفرة المصدر في 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)

قم بتشغيل التنفيذ الآمن لمؤشر الترابط للوظيفة أو الطريقة.

شفرة المصدر في 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__()

تهيئة فئة الديكور لتنفيذ مؤشر ترابط آمن لوظيفة أو طريقة.

شفرة المصدر في 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

قواعد: ContextDecorator

Ultralytics حاول باستثناء الطبقة. استخدم كمصمم ديكور @TryExcept () أو "مع TryCept():" مدير السياق.

امثله:

كمصمم ديكور:

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

بصفتك مديرا للسياق:

>>> with TryExcept(msg="Error occurred in block", verbose=True):
>>>     # Code block here
>>>     pass
شفرة المصدر في 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__()

ينفذ عند إدخال سياق TryExcept ، وتهيئة المثيل.

شفرة المصدر في ultralytics/utils/__init__.py
def __enter__(self):
    """Executes when entering TryExcept context, initializes instance."""
    pass

__exit__(exc_type, value, traceback)

يحدد السلوك عند الخروج من كتلة "مع" ، ويطبع رسالة خطأ إذا لزم الأمر.

شفرة المصدر في 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)

قم بتهيئة فئة TryExcept باستخدام إعدادات الرسائل والإسهاب الاختيارية.

شفرة المصدر في 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

قواعد: ContextDecorator

أعد محاولة الفئة لتنفيذ الدالة مع التراجع الأسي.

يمكن استخدامه كمُزيِّن لإعادة محاولة دالة على الاستثناءات، حتى عدد محدد من المرات مع بتأخير متزايد أضعافًا مضاعفة بين إعادة المحاولة.

امثله:

مثال على الاستخدام كديكور:

>>> @Retry(times=3, delay=2)
>>> def test_func():
>>>     # Replace with function logic that may raise exceptions
>>>     return True
شفرة المصدر في ultralytics/utils/__init__.py
class Retry(contextlib.ContextDecorator):
    """
    Retry class for function execution with exponential backoff.

    Can be used as a decorator to retry a function 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
    """

    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

__call__(func)

تنفيذ الديكور لإعادة المحاولة مع تراجع أسي.

شفرة المصدر في 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

__init__(times=3, delay=2)

تهيئة فئة إعادة المحاولة مع عدد محدد من عمليات إعادة المحاولة والتأخير.

شفرة المصدر في 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

قواعد: dict

يدير Ultralytics الإعدادات المخزنة في ملف YAML.

البارامترات:

اسم نوع وصف افتراضي
file str | Path

الطريق إلى Ultralytics إعدادات ملف YAML. الافتراضي هو USER_CONFIG_DIR / 'settings.yaml'.

SETTINGS_YAML
version str

إصدار الإعدادات. في حالة عدم تطابق الإصدار المحلي ، سيتم حفظ الإعدادات الافتراضية الجديدة.

'0.0.4'
شفرة المصدر في 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

        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)
            help_msg = (
                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'. "
                "For help see https://docs.ultralytics.com/quickstart/#ultralytics-settings."
            )
            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 "
                    f"with your settings or a recent ultralytics package update. {help_msg}"
                )
                self.reset()

            if self.get("datasets_dir") == self.get("runs_dir"):
                LOGGER.warning(
                    f"WARNING ⚠️ Ultralytics setting 'datasets_dir: {self.get('datasets_dir')}' "
                    f"must be different than 'runs_dir: {self.get('runs_dir')}'. "
                    f"Please change one to avoid possible issues during training. {help_msg}"
                )

    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')

تهيئة مدير الإعدادات بالإعدادات الافتراضية ، وتحميل الإعدادات الحالية والتحقق من صحتها من YAML ملف.

شفرة المصدر في 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

    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)
        help_msg = (
            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'. "
            "For help see https://docs.ultralytics.com/quickstart/#ultralytics-settings."
        )
        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 "
                f"with your settings or a recent ultralytics package update. {help_msg}"
            )
            self.reset()

        if self.get("datasets_dir") == self.get("runs_dir"):
            LOGGER.warning(
                f"WARNING ⚠️ Ultralytics setting 'datasets_dir: {self.get('datasets_dir')}' "
                f"must be different than 'runs_dir: {self.get('runs_dir')}'. "
                f"Please change one to avoid possible issues during training. {help_msg}"
            )

load()

تحميل الإعدادات من ملف YAML.

شفرة المصدر في ultralytics/utils/__init__.py
def load(self):
    """Loads settings from the YAML file."""
    super().update(yaml_load(self.file))

reset()

يعيد ضبط الإعدادات إلى الوضع الافتراضي ويحفظها.

شفرة المصدر في ultralytics/utils/__init__.py
def reset(self):
    """Resets the settings to default and saves them."""
    self.clear()
    self.update(self.defaults)
    self.save()

save()

يحفظ الإعدادات الحالية إلى ملف YAML.

شفرة المصدر في ultralytics/utils/__init__.py
def save(self):
    """Saves the current settings to the YAML file."""
    yaml_save(self.file, dict(self))

update(*args, **kwargs)

تحديث قيمة إعداد في الإعدادات الحالية.

شفرة المصدر في 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')

مصمم لتعيين معلمات rc مؤقتا والواجهة الخلفية لوظيفة التخطيط.

مثل

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

البارامترات:

اسم نوع وصف افتراضي
rcparams dict

قاموس معلمات RC لتعيين.

None
backend str

اسم الواجهة الخلفية المراد استخدامها. الإعدادات الافتراضية إلى "Agg".

'Agg'

ارجاع:

نوع وصف
Callable

وظيفة مزينة مع تعيين مؤقتا معلمات rc والخلفية. يمكن أن يكون هذا الديكور يتم تطبيقه على أي وظيفة تحتاج إلى معلمات Matplotlib RC محددة وخلفية لتنفيذها.

شفرة المصدر في 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)

يقوم بإعداد التسجيل للاسم المحدد مع دعم ترميز UTF-8 ، مما يضمن التوافق عبر مختلف البيئات.

شفرة المصدر في ultralytics/utils/__init__.py
def set_logging(name="LOGGING_NAME", verbose=True):
    """Sets up logging for the given name with UTF-8 encoding support, ensuring compatibility across different
    environments.
    """
    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, with checks for compatibility
    formatter = logging.Formatter("%(message)s")  # Default formatter
    if WINDOWS and hasattr(sys.stdout, "encoding") and sys.stdout.encoding != "utf-8":

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

        try:
            # Attempt to reconfigure stdout to use UTF-8 encoding if possible
            if hasattr(sys.stdout, "reconfigure"):
                sys.stdout.reconfigure(encoding="utf-8")
            # For environments where reconfigure is not available, wrap stdout in a TextIOWrapper
            elif hasattr(sys.stdout, "buffer"):
                import io

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

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

    # Set up the logger
    logger = logging.getLogger(name)
    logger.setLevel(level)
    logger.addHandler(stream_handler)
    logger.propagate = False
    return logger



ultralytics.utils.emojis(string='')

إرجاع نسخة آمنة من الرموز التعبيرية المعتمدة على النظام الأساسي من السلسلة.

شفرة المصدر في 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='')

حفظ بيانات YAML في ملف.

البارامترات:

اسم نوع وصف افتراضي
file str

اسم الملف. الافتراضي هو "data.yaml".

'data.yaml'
data dict

البيانات المراد حفظها بتنسيق YAML.

None
header str

رأس YAML لإضافته.

''

ارجاع:

نوع وصف
None

يتم حفظ البيانات في الملف المحدد.

شفرة المصدر في 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)

تحميل بيانات YAML من ملف.

البارامترات:

اسم نوع وصف افتراضي
file str

اسم الملف. الافتراضي هو "data.yaml".

'data.yaml'
append_filename bool

إضافة اسم ملف YAML إلى قاموس YAML. الافتراضي هو خطأ.

False

ارجاع:

نوع وصف
dict

بيانات YAML واسم الملف.

شفرة المصدر في 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)

جميلة تطبع ملف YAML أو قاموس YAML.

البارامترات:

اسم نوع وصف افتراضي
yaml_file Union[str, Path, dict]

مسار ملف ملف YAML أو قاموس بتنسيق YAML.

مطلوب

ارجاع:

نوع وصف
None

(لا يوجد)

شفرة المصدر في 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, width=float("inf"))
    LOGGER.info(f"Printing '{colorstr('bold', 'black', yaml_file)}'\n\n{dump}")



ultralytics.utils.read_device_model()

يقرأ معلومات نموذج الجهاز من النظام ويخزنها مؤقتًا للوصول السريع. يُستخدم بواسطة is_jetson() و is_raspberrypi().

ارجاع:

نوع وصف
str

محتويات الملف النموذجي إذا تمت قراءته بنجاح أو سلسلة فارغة في غير ذلك.

شفرة المصدر في ultralytics/utils/__init__.py
def read_device_model() -> str:
    """
    Reads the device model information from the system and caches it for quick access. Used by is_jetson() and
    is_raspberrypi().

    Returns:
        (str): Model file contents if read successfully or empty string otherwise.
    """
    with contextlib.suppress(Exception):
        with open("/proc/device-tree/model") as f:
            return f.read()
    return ""



ultralytics.utils.is_ubuntu()

تحقق مما إذا كان نظام التشغيل هو أوبونتو.

ارجاع:

نوع وصف
bool

صحيح إذا كان نظام التشغيل هو Ubuntu ، خطأ خلاف ذلك.

شفرة المصدر في 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()

تحقق مما إذا كان النص البرمجي الحالي يعمل داخل دفتر ملاحظات Google Colab.

ارجاع:

نوع وصف
bool

صحيح إذا كان يعمل داخل دفتر ملاحظات كولاب ، خطأ خلاف ذلك.

شفرة المصدر في 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()

تحقق مما إذا كان البرنامج النصي الحالي يعمل داخل نواة Kaggle.

ارجاع:

نوع وصف
bool

صحيح إذا كان يعمل داخل نواة Kaggle ، خطأ خلاف ذلك.

شفرة المصدر في 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()

تحقق مما إذا كان البرنامج النصي الحالي يعمل داخل دفتر ملاحظات Jupyter. تم التحقق منه على كولاب ، جوبيترلاب ، كاجل ، Paperspace.

ارجاع:

نوع وصف
bool

صحيح إذا كان يعمل داخل دفتر Jupyter ، خطأ خلاف ذلك.

شفرة المصدر في 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()

حدد ما إذا كان البرنامج النصي يعمل داخل حاوية Docker.

ارجاع:

نوع وصف
bool

صحيح إذا كان البرنامج النصي يعمل داخل حاوية Docker ، خطأ خلاف ذلك.

شفرة المصدر في 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.
    """
    with contextlib.suppress(Exception):
        with open("/proc/self/cgroup") as f:
            return "docker" in f.read()
    return False



ultralytics.utils.is_raspberrypi()

يحدّد ما إذا كانت البيئة Python تعمل على جهاز Raspberry Pi من خلال التحقق من معلومات طراز الجهاز.

ارجاع:

نوع وصف
bool

صواب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان يعمل على جهاز Raspberry Pi، وكاذب إذا كان غير ذلك.

شفرة المصدر في ultralytics/utils/__init__.py
def is_raspberrypi() -> bool:
    """
    Determines if the Python environment is running on a Raspberry Pi by checking the device model information.

    Returns:
        (bool): True if running on a Raspberry Pi, False otherwise.
    """
    return "Raspberry Pi" in PROC_DEVICE_MODEL



ultralytics.utils.is_jetson()

يُحدد ما إذا كانت البيئة Python تعمل على جهاز Jetson Nano أو Jetson Orin من خلال التحقق من طراز الجهاز المعلومات.

ارجاع:

نوع وصف
bool

صواب في حالة التشغيل على Jetson Nano أو Jetson Orin، خطأ في غير ذلك.

شفرة المصدر في ultralytics/utils/__init__.py
def is_jetson() -> bool:
    """
    Determines if the Python environment is running on a Jetson Nano or Jetson Orin device by checking the device model
    information.

    Returns:
        (bool): True if running on a Jetson Nano or Jetson Orin, False otherwise.
    """
    return "NVIDIA" in PROC_DEVICE_MODEL  # i.e. "NVIDIA Jetson Nano" or "NVIDIA Orin NX"



ultralytics.utils.is_online()

تحقق من الاتصال بالإنترنت عن طريق محاولة الاتصال بمضيف معروف عبر الإنترنت.

ارجاع:

نوع وصف
bool

صحيح إذا كان الاتصال ناجحا ، خطأ خلاف ذلك.

شفرة المصدر في 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.
    """
    with contextlib.suppress(Exception):
        assert str(os.getenv("YOLO_OFFLINE", "")).lower() != "true"  # check if ENV var YOLO_OFFLINE="True"
        import socket

        for dns in ("1.1.1.1", "8.8.8.8"):  # check Cloudflare and Google DNS
            socket.create_connection(address=(dns, 80), timeout=2.0).close()
            return True
    return False



ultralytics.utils.is_pip_package(filepath=__name__)

يحدد ما إذا كان الملف في مسار الملف المحدد هو جزء من حزمة نقطة.

البارامترات:

اسم نوع وصف افتراضي
filepath str

مسار الملف للتحقق.

__name__

ارجاع:

نوع وصف
bool

صحيح إذا كان الملف جزءا من حزمة نقطة ، خطأ خلاف ذلك.

شفرة المصدر في 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)

تحقق مما إذا كان الدليل قابلا للكتابة.

البارامترات:

اسم نوع وصف افتراضي
dir_path str | Path

المسار إلى الدليل.

مطلوب

ارجاع:

نوع وصف
bool

صحيح إذا كان الدليل قابلا للكتابة ، خطأ بخلاف ذلك.

شفرة المصدر في 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()

يحدد ما إذا كان pytest قيد التشغيل حاليا أم لا.

ارجاع:

نوع وصف
bool

صحيح إذا كان pytest قيد التشغيل ، خطأ خلاف ذلك.

شفرة المصدر في 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(ARGV[0]).stem)



ultralytics.utils.is_github_action_running()

حدد ما إذا كانت البيئة الحالية عداء إجراءات GitHub.

ارجاع:

نوع وصف
bool

صحيح إذا كانت البيئة الحالية عبارة عن عداء GitHub Actions ، فهذا خطأ بخلاف ذلك.

شفرة المصدر في 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.get_git_dir()

يحدد ما إذا كان الملف الحالي جزءا من مستودع git وإذا كان الأمر كذلك، فيرجع الدليل الجذر للمستودع. لو الملف الحالي ليس جزءا من مستودع git ، يقوم بإرجاع بلا.

ارجاع:

نوع وصف
Path | None

دليل جذر Git إذا تم العثور عليه أو لا شيء إذا لم يتم العثور عليه.

شفرة المصدر في 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.is_git_dir()

يحدد ما إذا كان الملف الحالي جزءا من مستودع git أم لا. إذا لم يكن الملف الحالي جزءا من git المستودع، إرجاع بلا.

ارجاع:

نوع وصف
bool

صحيح إذا كان الملف الحالي جزءا من مستودع git.

شفرة المصدر في 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 GIT_DIR is not None



ultralytics.utils.get_git_origin_url()

يسترجع عنوان URL الأصلي لمستودع git.

ارجاع:

نوع وصف
str | None

عنوان URL الأصلي لمستودع git أو لا شيء إن لم يكن دليل git.

شفرة المصدر في 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()

إرجاع اسم فرع git الحالي. إذا لم يكن في مستودع git ، فترجع بلا.

ارجاع:

نوع وصف
str | None

اسم فرع git الحالي أو لا شيء إن لم يكن دليل git.

شفرة المصدر في 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)

إرجاع قاموس للوسيطات الافتراضية لدالة.

البارامترات:

اسم نوع وصف افتراضي
func callable

وظيفة التفتيش.

مطلوب

ارجاع:

نوع وصف
dict

قاموس حيث يكون كل مفتاح هو اسم معلمة ، وكل قيمة هي القيمة الافتراضية لتلك المعلمة.

شفرة المصدر في 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()

استرجع إصدار Ubuntu إذا كان نظام التشغيل هو Ubuntu.

ارجاع:

نوع وصف
str

إصدار Ubuntu أو لا شيء إن لم يكن نظام تشغيل Ubuntu.

شفرة المصدر في 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')

إرجاع دليل التكوين المناسب استنادا إلى نظام تشغيل البيئة.

البارامترات:

اسم نوع وصف افتراضي
sub_dir str

اسم الدليل الفرعي المراد إنشاؤه.

'Ultralytics'

ارجاع:

نوع وصف
Path

المسار إلى دليل تكوين المستخدم.

شفرة المصدر في 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)

يلون سلسلة بناء على وسيطات اللون والنمط المتوفرة. يستخدم رموز الهروب ANSI. راجع https://en.wikipedia.org/wiki/ANSI_escape_code لمزيد من التفاصيل.

يمكن استدعاء هذه الوظيفة بطريقتين
  • colorstr ("اللون" ، "النمط" ، "السلسلة الخاصة بك")
  • Colorstr ("سلسلتك")

في النموذج الثاني ، سيتم تطبيق "الأزرق" و "الغامق" افتراضيا.

البارامترات:

اسم نوع وصف افتراضي
*input str

سلسلة من السلاسل حيث تكون سلاسل n-1 الأولى عبارة عن وسيطات اللون والنمط ، والخيط الأخير هو الذي سيتم تلوينه.

()
الألوان والأنماط المدعومة

الألوان الأساسية: "أسود" ، "أحمر" ، "أخضر" ، "أصفر" ، "أزرق" ، "أرجواني" ، "سماوي" ، "أبيض" الألوان الزاهية: "bright_black" ، "bright_red" ، "bright_green" ، "bright_yellow" ، "bright_blue" و "bright_magenta" و "bright_cyan" و "bright_white" متفرقات: "نهاية" ، "جريئة" ، "تسطير"

ارجاع:

نوع وصف
str

سلسلة الإدخال ملفوفة برموز الهروب ANSI للون والنمط المحددين.

امثله:

>>> colorstr("blue", "bold", "hello world")
>>> "hello world"
شفرة المصدر في 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)

يزيل رموز الهروب ANSI من سلسلة ، وإلغاء تلوينها بشكل فعال.

البارامترات:

اسم نوع وصف افتراضي
input_string str

سلسلة لإزالة اللون والنمط من.

مطلوب

ارجاع:

نوع وصف
str

تمت إزالة سلسلة جديدة مع إزالة جميع رموز الهروب ANSI.

امثله:

>>> remove_colorstr(colorstr('blue', 'bold', 'hello world'))
>>> 'hello world'
شفرة المصدر في 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)

مؤشرات الترابط المتعددة دالة هدف بشكل افتراضي وإرجاع نتيجة مؤشر الترابط أو الدالة.

استخدم كديكور @threaded. تعمل الدالة في مؤشر ترابط منفصل ما لم يتم تمرير "threaded = False".

شفرة المصدر في 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()

تهيئة Sentry SDK لتعقب الأخطاء وإعداد التقارير. تستخدم فقط إذا تم تثبيت sentry_sdk الحزمة و sync = صحيح في الإعدادات. تشغيل 'yolo 'لرؤية وتحديث إعدادات ملف YAML.

الشروط المطلوبة لإرسال الأخطاء (يجب استيفاء جميع الشروط أو لن يتم الإبلاغ عن أي أخطاء): - تم تثبيت حزمة sentry_sdk - sync = صحيح في YOLO اعدادات - pytest لا يعمل - يعمل في تثبيت حزمة نقطة - يعمل في دليل غير git - الجري برتبة -1 أو 0 - بيئة على الانترنت - CLI تستخدم لتشغيل الحزمة (تم التحقق منها باستخدام 'yolo' كاسم رئيسي CLI أمر)

تقوم الدالة أيضا بتكوين Sentry SDK لتجاهل KeyboardInterrupt و FileNotFoundError الاستثناءات واستبعاد الأحداث التي تحتوي على "نفاد الذاكرة" في رسالة الاستثناء الخاصة بها.

بالإضافة إلى ذلك ، تقوم الوظيفة بتعيين علامات مخصصة ومعلومات المستخدم لأحداث Sentry.

شفرة المصدر في 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": ARGV[0],
            "sys_argv_name": Path(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(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)

إصدار تحذير إيقاف عند استخدام وسيطة مهملة، مما يشير إلى وسيطة محدثة.

شفرة المصدر في 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)

قم بتجريد المصادقة من عنوان URL ، أي https://url.com/file.txt?auth -> https://url.com/file.txt.

شفرة المصدر في 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)

تحويل URL إلى اسم الملف ، أي https://url.com/file.txt?auth -> file.txt.

شفرة المصدر في 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





Created 2023-11-12, Updated 2024-06-02
Authors: glenn-jocher (10), Burhan-Q (1), Laughing-q (1)