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

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

ملاحظه

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



ultralytics.utils.files.WorkingDirectory

قواعد: ContextDecorator

الاستعمال: @WorkingDirectory (dir) الديكور أو "مع WorkingDirectory (دير):" مدير السياق.

شفرة المصدر في ultralytics/utils/files.py
class WorkingDirectory(contextlib.ContextDecorator):
    """Usage: @WorkingDirectory(dir) decorator or 'with WorkingDirectory(dir):' context manager."""

    def __init__(self, new_dir):
        """Sets the working directory to 'new_dir' upon instantiation."""
        self.dir = new_dir  # new dir
        self.cwd = Path.cwd().resolve()  # current dir

    def __enter__(self):
        """Changes the current directory to the specified directory."""
        os.chdir(self.dir)

    def __exit__(self, exc_type, exc_val, exc_tb):  # noqa
        """Restore the current working directory on context exit."""
        os.chdir(self.cwd)

__enter__()

يغير الدليل الحالي إلى الدليل المحدد.

شفرة المصدر في ultralytics/utils/files.py
def __enter__(self):
    """Changes the current directory to the specified directory."""
    os.chdir(self.dir)

__exit__(exc_type, exc_val, exc_tb)

استعادة دليل العمل الحالي عند إنهاء السياق.

شفرة المصدر في ultralytics/utils/files.py
def __exit__(self, exc_type, exc_val, exc_tb):  # noqa
    """Restore the current working directory on context exit."""
    os.chdir(self.cwd)

__init__(new_dir)

يضبط دليل العمل على "new_dir" عند إنشاء مثيل.

شفرة المصدر في ultralytics/utils/files.py
def __init__(self, new_dir):
    """Sets the working directory to 'new_dir' upon instantiation."""
    self.dir = new_dir  # new dir
    self.cwd = Path.cwd().resolve()  # current dir



ultralytics.utils.files.spaces_in_path(path)

مدير السياق للتعامل مع المسارات ذات المسافات في أسمائها. إذا كان المسار يحتوي على مسافات، فإنه يستبدلها ب تسطير سفلي، ينسخ الملف/الدليل إلى المسار الجديد، وينفذ كتلة التعليمات البرمجية للسياق، ثم ينسخ الملف / الدليل مرة أخرى إلى موقعه الأصلي.

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

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

المسار الأصلي.

مطلوب

غلال:

نوع وصف
Path

مسار مؤقت مع استبدال المسافات بشرطة سفلية إذا كانت المسافات موجودة، وإلا فإن المسار الأصلي.

مثل
with ultralytics.utils.files import spaces_in_path

with spaces_in_path('/path/with spaces') as new_path:
    # Your code here
شفرة المصدر في ultralytics/utils/files.py
@contextmanager
def spaces_in_path(path):
    """
    Context manager to handle paths with spaces in their names. If a path contains spaces, it replaces them with
    underscores, copies the file/directory to the new path, executes the context code block, then copies the
    file/directory back to its original location.

    Args:
        path (str | Path): The original path.

    Yields:
        (Path): Temporary path with spaces replaced by underscores if spaces were present, otherwise the original path.

    Example:
        ```python
        with ultralytics.utils.files import spaces_in_path

        with spaces_in_path('/path/with spaces') as new_path:
            # Your code here
        ```
    """

    # If path has spaces, replace them with underscores
    if " " in str(path):
        string = isinstance(path, str)  # input type
        path = Path(path)

        # Create a temporary directory and construct the new path
        with tempfile.TemporaryDirectory() as tmp_dir:
            tmp_path = Path(tmp_dir) / path.name.replace(" ", "_")

            # Copy file/directory
            if path.is_dir():
                # tmp_path.mkdir(parents=True, exist_ok=True)
                shutil.copytree(path, tmp_path)
            elif path.is_file():
                tmp_path.parent.mkdir(parents=True, exist_ok=True)
                shutil.copy2(path, tmp_path)

            try:
                # Yield the temporary path
                yield str(tmp_path) if string else tmp_path

            finally:
                # Copy file/directory back
                if tmp_path.is_dir():
                    shutil.copytree(tmp_path, path, dirs_exist_ok=True)
                elif tmp_path.is_file():
                    shutil.copy2(tmp_path, path)  # Copy back the file

    else:
        # If there are no spaces, just yield the original path
        yield path



ultralytics.utils.files.increment_path(path, exist_ok=False, sep='', mkdir=False)

يزيد مسار ملف أو دليل ، أي تشغيل / exp --> تشغيل / exp {sep}2 ، تشغيل / exp {sep}3 ، ... الخ.

إذا كان المسار موجودا ولم يتم تعيين exist_ok إلى True ، زيادة المسار عن طريق إلحاق رقم و sep إلى نهاية المسار. إذا كان المسار عبارة عن ملف ، الاحتفاظ بامتداد الملف. إذا كان المسار عبارة عن دليل، فإن الزر سيتم إلحاق الرقم مباشرة بنهاية المسار. إذا تم تعيين mkdir إلى True ، إنشاء المسار ك إذا لم يكن موجودا بالفعل.

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

اسم نوع وصف افتراضي
path (str, Path)

الطريق إلى الزيادة.

مطلوب
exist_ok bool

إذا كان صحيحا، فلن يتم زيادة المسار وإعادته كما هو. الإعدادات الافتراضية إلى خطأ.

False
sep str

فاصل للاستخدام بين المسار ورقم الزيادة. الإعدادات الافتراضية إلى ''.

''
mkdir bool

قم بإنشاء دليل إذا لم يكن موجودا. الإعدادات الافتراضية إلى خطأ.

False

ارجاع:

نوع وصف
Path

مسار متزايد.

شفرة المصدر في ultralytics/utils/files.py
def increment_path(path, exist_ok=False, sep="", mkdir=False):
    """
    Increments a file or directory path, i.e. runs/exp --> runs/exp{sep}2, runs/exp{sep}3, ... etc.

    If the path exists and exist_ok is not set to True, the path will be incremented by appending a number and sep to
    the end of the path. If the path is a file, the file extension will be preserved. If the path is a directory, the
    number will be appended directly to the end of the path. If mkdir is set to True, the path will be created as a
    directory if it does not already exist.

    Args:
        path (str, pathlib.Path): Path to increment.
        exist_ok (bool, optional): If True, the path will not be incremented and returned as-is. Defaults to False.
        sep (str, optional): Separator to use between the path and the incrementation number. Defaults to ''.
        mkdir (bool, optional): Create a directory if it does not exist. Defaults to False.

    Returns:
        (pathlib.Path): Incremented path.
    """
    path = Path(path)  # os-agnostic
    if path.exists() and not exist_ok:
        path, suffix = (path.with_suffix(""), path.suffix) if path.is_file() else (path, "")

        # Method 1
        for n in range(2, 9999):
            p = f"{path}{sep}{n}{suffix}"  # increment path
            if not os.path.exists(p):
                break
        path = Path(p)

    if mkdir:
        path.mkdir(parents=True, exist_ok=True)  # make directory

    return path



ultralytics.utils.files.file_age(path=__file__)

أيام العودة منذ آخر تحديث للملف.

شفرة المصدر في ultralytics/utils/files.py
def file_age(path=__file__):
    """Return days since last file update."""
    dt = datetime.now() - datetime.fromtimestamp(Path(path).stat().st_mtime)  # delta
    return dt.days  # + dt.seconds / 86400  # fractional days



ultralytics.utils.files.file_date(path=__file__)

قم بإرجاع تاريخ تعديل الملف الذي يمكن للبشر قراءته ، أي "2021-3-26".

شفرة المصدر في ultralytics/utils/files.py
def file_date(path=__file__):
    """Return human-readable file modification date, i.e. '2021-3-26'."""
    t = datetime.fromtimestamp(Path(path).stat().st_mtime)
    return f"{t.year}-{t.month}-{t.day}"



ultralytics.utils.files.file_size(path)

حجم الملف / الإخراج للإرجاع (ميغابايت).

شفرة المصدر في ultralytics/utils/files.py
def file_size(path):
    """Return file/dir size (MB)."""
    if isinstance(path, (str, Path)):
        mb = 1 << 20  # bytes to MiB (1024 ** 2)
        path = Path(path)
        if path.is_file():
            return path.stat().st_size / mb
        elif path.is_dir():
            return sum(f.stat().st_size for f in path.glob("**/*") if f.is_file()) / mb
    return 0.0



ultralytics.utils.files.get_latest_run(search_dir='.')

قم بإرجاع المسار إلى أحدث "last.pt" في / runs (أي إلى --resume from).

شفرة المصدر في ultralytics/utils/files.py
def get_latest_run(search_dir="."):
    """Return path to most recent 'last.pt' in /runs (i.e. to --resume from)."""
    last_list = glob.glob(f"{search_dir}/**/last*.pt", recursive=True)
    return max(last_list, key=os.path.getctime) if last_list else ""



ultralytics.utils.files.update_models(model_names=('yolov8n.pt'), source_dir=Path('.'), update_names=False)

التحديثات وإعادة الحفظ المحددة YOLO النماذج في دليل فرعي "updated_models".

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

اسم نوع وصف افتراضي
model_names tuple

أسماء ملفات النموذج المراد تحديثها، الإعدادات الافتراضية هي ("yolov8n.pt").

('yolov8n.pt')
source_dir Path

دليل يحتوي على نماذج ودليل فرعي هدف ، افتراضيات إلى الدليل الحالي.

Path('.')
update_names bool

تحديث أسماء النماذج من بيانات YAML.

False
مثل
from ultralytics.utils.files import update_models

model_names = (f"rtdetr-{size}.pt" for size in "lx")
update_models(model_names)
شفرة المصدر في ultralytics/utils/files.py
def update_models(model_names=("yolov8n.pt",), source_dir=Path("."), update_names=False):
    """
    Updates and re-saves specified YOLO models in an 'updated_models' subdirectory.

    Args:
        model_names (tuple, optional): Model filenames to update, defaults to ("yolov8n.pt").
        source_dir (Path, optional): Directory containing models and target subdirectory, defaults to current directory.
        update_names (bool, optional): Update model names from a data YAML.

    Example:
        ```python
        from ultralytics.utils.files import update_models

        model_names = (f"rtdetr-{size}.pt" for size in "lx")
        update_models(model_names)
        ```
    """
    from ultralytics import YOLO
    from ultralytics.nn.autobackend import default_class_names

    target_dir = source_dir / "updated_models"
    target_dir.mkdir(parents=True, exist_ok=True)  # Ensure target directory exists

    for model_name in model_names:
        model_path = source_dir / model_name
        print(f"Loading model from {model_path}")

        # Load model
        model = YOLO(model_path)
        model.half()
        if update_names:  # update model names from a dataset YAML
            model.model.names = default_class_names("coco8.yaml")

        # Define new save path
        save_path = target_dir / model_name

        # Save model using model.save()
        print(f"Re-saving {model_name} model to {save_path}")
        model.save(save_path, use_dill=False)





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