सामग्री पर जाएं

के लिए संदर्भ ultralytics/utils/downloads.py

नोट

यह फ़ाइल यहाँ उपलब्ध है https://github.com/ultralytics/ultralytics/बूँद/मुख्य/ultralytics/utils/downloads.py का उपयोग करें। यदि आप कोई समस्या देखते हैं तो कृपया पुल अनुरोध का योगदान करके इसे ठीक करने में मदद करें 🛠️। 🙏 धन्यवाद !



ultralytics.utils.downloads.is_url(url, check=True)

सत्यापित करता है कि दी गई स्ट्रिंग एक URL है और वैकल्पिक रूप से जांचता है कि URL ऑनलाइन मौजूद है या नहीं।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
url str

URL के रूप में मान्य की जाने वाली स्ट्रिंग.

आवश्यक
check bool

यदि सही है, तो यह देखने के लिए एक अतिरिक्त जांच करता है कि URL ऑनलाइन मौजूद है या नहीं। सही करने के लिए डिफ़ॉल्ट।

True

देता:

प्रकार विवरण: __________
bool

यदि स्ट्रिंग एक मान्य URL है, तो True लौटाता है. अगर "check" सही है, तो अगर यूआरएल ऑनलाइन मौजूद है, तो यह भी सही दिखाता है. अन्यथा गलत लौटाता है।

उदाहरण
valid = is_url("https://www.example.com")
में स्रोत कोड ultralytics/utils/downloads.py
34 बांग्लादेश बांग्लादेश 34 बांग्लादेश36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51525354 555657585960
def is_url(url, check=True):
    """
    Validates if the given string is a URL and optionally checks if the URL exists online.

    Args:
        url (str): The string to be validated as a URL.
        check (bool, optional): If True, performs an additional check to see if the URL exists online.
            Defaults to True.

    Returns:
        (bool): Returns True if the string is a valid URL. If 'check' is True, also returns True if the URL exists online.
            Returns False otherwise.

    Example:
        ```python
        valid = is_url("https://www.example.com")
        ```
    """
    with contextlib.suppress(Exception):
        url = str(url)
        result = parse.urlparse(url)
        assert all([result.scheme, result.netloc])  # check if is url
        if check:
            with request.urlopen(url) as response:
                return response.getcode() == 200  # check if exists online
        return True
    return False



ultralytics.utils.downloads.delete_dsstore(path, files_to_delete=('.DS_Store', '__MACOSX'))

निर्दिष्ट निर्देशिका के अंतर्गत सभी ".DS_store" फ़ाइलों को हटा देता है।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
path str

निर्देशिका पथ जहां ".DS_store" फ़ाइलों को हटाया जाना चाहिए।

आवश्यक
files_to_delete tuple

हटाई जाने वाली फ़ाइलें।

('.DS_Store', '__MACOSX')
उदाहरण
from ultralytics.utils.downloads import delete_dsstore

delete_dsstore('path/to/dir')
नोट

".DS_store" फ़ाइलें Apple ऑपरेटिंग सिस्टम द्वारा बनाई जाती हैं और इनमें फ़ोल्डरों और फ़ाइलों के बारे में मेटाडेटा होता है। वे छिपी हुई सिस्टम फाइलें हैं और विभिन्न ऑपरेटिंग सिस्टम के बीच फ़ाइलों को स्थानांतरित करते समय समस्याएं पैदा कर सकती हैं।

में स्रोत कोड ultralytics/utils/downloads.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 777879 80 81 828384 8586
def delete_dsstore(path, files_to_delete=(".DS_Store", "__MACOSX")):
    """
    Deletes all ".DS_store" files under a specified directory.

    Args:
        path (str, optional): The directory path where the ".DS_store" files should be deleted.
        files_to_delete (tuple): The files to be deleted.

    Example:
        ```python
        from ultralytics.utils.downloads import delete_dsstore

        delete_dsstore('path/to/dir')
        ```

    Note:
        ".DS_store" files are created by the Apple operating system and contain metadata about folders and files. They
        are hidden system files and can cause issues when transferring files between different operating systems.
    """
    for file in files_to_delete:
        matches = list(Path(path).rglob(file))
        LOGGER.info(f"Deleting {file} files: {matches}")
        for f in matches:
            f.unlink()



ultralytics.utils.downloads.zip_directory(directory, compress=True, exclude=('.DS_Store', '__MACOSX'), progress=True)

एक निर्देशिका की सामग्री को ज़िप करता है, बहिष्कृत सूची में स्ट्रिंग्स वाली फ़ाइलों को छोड़कर। परिणामी ज़िप फ़ाइल है निर्देशिका के नाम पर रखा गया और इसके साथ रखा गया।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
directory str | Path

ज़िप की जाने वाली निर्देशिका का पथ।

आवश्यक
compress bool

ज़िप करते समय फ़ाइलों को संपीड़ित करना है या नहीं। डिफ़ॉल्ट True है.

True
exclude tuple

फ़ाइल नाम स्ट्रिंग्स का एक टपल बाहर रखा जाना है। ('.DS_Store', '__MACOSX') के लिए डिफ़ॉल्ट।

('.DS_Store', '__MACOSX')
progress bool

प्रगति पट्टी प्रदर्शित करनी है या नहीं. सही करने के लिए डिफ़ॉल्ट।

True

देता:

प्रकार विवरण: __________
Path

परिणामी ज़िप फ़ाइल का पथ।

उदाहरण
from ultralytics.utils.downloads import zip_directory

file = zip_directory('path/to/dir')
में स्रोत कोड ultralytics/utils/downloads.py
 89 90 91 92 93 94 95 96 97 98  99 100 101 102 103 104 105 106 107  108 109 110 111 112  113 114 115 116 117 118119 120   121 122 123124 125
def zip_directory(directory, compress=True, exclude=(".DS_Store", "__MACOSX"), progress=True):
    """
    Zips the contents of a directory, excluding files containing strings in the exclude list. The resulting zip file is
    named after the directory and placed alongside it.

    Args:
        directory (str | Path): The path to the directory to be zipped.
        compress (bool): Whether to compress the files while zipping. Default is True.
        exclude (tuple, optional): A tuple of filename strings to be excluded. Defaults to ('.DS_Store', '__MACOSX').
        progress (bool, optional): Whether to display a progress bar. Defaults to True.

    Returns:
        (Path): The path to the resulting zip file.

    Example:
        ```python
        from ultralytics.utils.downloads import zip_directory

        file = zip_directory('path/to/dir')
        ```
    """
    from zipfile import ZIP_DEFLATED, ZIP_STORED, ZipFile

    delete_dsstore(directory)
    directory = Path(directory)
    if not directory.is_dir():
        raise FileNotFoundError(f"Directory '{directory}' does not exist.")

    # Unzip with progress bar
    files_to_zip = [f for f in directory.rglob("*") if f.is_file() and all(x not in f.name for x in exclude)]
    zip_file = directory.with_suffix(".zip")
    compression = ZIP_DEFLATED if compress else ZIP_STORED
    with ZipFile(zip_file, "w", compression) as f:
        for file in TQDM(files_to_zip, desc=f"Zipping {directory} to {zip_file}...", unit="file", disable=not progress):
            f.write(file, file.relative_to(directory))

    return zip_file  # return path to zip file



ultralytics.utils.downloads.unzip_file(file, path=None, exclude=('.DS_Store', '__MACOSX'), exist_ok=False, progress=True)

निर्दिष्ट पथ पर एक * .zip फ़ाइल को अनज़िप करता है, बहिष्कृत सूची में स्ट्रिंग्स वाली फ़ाइलों को छोड़कर।

यदि ज़िपफ़ाइल में एकल शीर्ष-स्तरीय निर्देशिका नहीं है, तो फ़ंक्शन एक नया बनाएगा अपनी सामग्री निकालने के लिए zipfile (एक्सटेंशन के बिना) के समान नाम के साथ निर्देशिका। यदि कोई पथ प्रदान नहीं किया गया है, तो फ़ंक्शन डिफ़ॉल्ट पथ के रूप में ज़िपफ़ाइल की मूल निर्देशिका का उपयोग करेगा।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
file str

ज़िपफ़ाइल का पथ निकाला जाना है।

आवश्यक
path str

ज़िपफ़ाइल को निकालने का पथ। कोई नहीं करने के लिए डिफ़ॉल्ट।

None
exclude tuple

फ़ाइल नाम स्ट्रिंग्स का एक टपल बाहर रखा जाना है। ('.DS_Store', '__MACOSX') के लिए डिफ़ॉल्ट।

('.DS_Store', '__MACOSX')
exist_ok bool

मौजूदा सामग्री को अधिलेखित करना है यदि वे मौजूद हैं। डिफ़ॉल्ट रूप से गलत है.

False
progress bool

प्रगति पट्टी प्रदर्शित करनी है या नहीं. सही करने के लिए डिफ़ॉल्ट।

True

उठाती:

प्रकार विवरण: __________
BadZipFile

यदि प्रदान की गई फ़ाइल मौजूद नहीं है या मान्य ज़िपफ़ाइल नहीं है।

देता:

प्रकार विवरण: __________
Path

निर्देशिका का पथ जहां ज़िपफ़ाइल निकाली गई थी।

उदाहरण
from ultralytics.utils.downloads import unzip_file

dir = unzip_file('path/to/file.zip')
में स्रोत कोड ultralytics/utils/downloads.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180181 182 183 184 185 186 187 188 189
def unzip_file(file, path=None, exclude=(".DS_Store", "__MACOSX"), exist_ok=False, progress=True):
    """
    Unzips a *.zip file to the specified path, excluding files containing strings in the exclude list.

    If the zipfile does not contain a single top-level directory, the function will create a new
    directory with the same name as the zipfile (without the extension) to extract its contents.
    If a path is not provided, the function will use the parent directory of the zipfile as the default path.

    Args:
        file (str): The path to the zipfile to be extracted.
        path (str, optional): The path to extract the zipfile to. Defaults to None.
        exclude (tuple, optional): A tuple of filename strings to be excluded. Defaults to ('.DS_Store', '__MACOSX').
        exist_ok (bool, optional): Whether to overwrite existing contents if they exist. Defaults to False.
        progress (bool, optional): Whether to display a progress bar. Defaults to True.

    Raises:
        BadZipFile: If the provided file does not exist or is not a valid zipfile.

    Returns:
        (Path): The path to the directory where the zipfile was extracted.

    Example:
        ```python
        from ultralytics.utils.downloads import unzip_file

        dir = unzip_file('path/to/file.zip')
        ```
    """
    from zipfile import BadZipFile, ZipFile, is_zipfile

    if not (Path(file).exists() and is_zipfile(file)):
        raise BadZipFile(f"File '{file}' does not exist or is a bad zip file.")
    if path is None:
        path = Path(file).parent  # default path

    # Unzip the file contents
    with ZipFile(file) as zipObj:
        files = [f for f in zipObj.namelist() if all(x not in f for x in exclude)]
        top_level_dirs = {Path(f).parts[0] for f in files}

        if len(top_level_dirs) > 1 or (len(files) > 1 and not files[0].endswith("/")):
            # Zip has multiple files at top level
            path = extract_path = Path(path) / Path(file).stem  # i.e. ../datasets/coco8
        else:
            # Zip has 1 top-level directory
            extract_path = path  # i.e. ../datasets
            path = Path(path) / list(top_level_dirs)[0]  # i.e. ../datasets/coco8

        # Check if destination directory already exists and contains files
        if path.exists() and any(path.iterdir()) and not exist_ok:
            # If it exists and is not empty, return the path without unzipping
            LOGGER.warning(f"WARNING ⚠️ Skipping {file} unzip as destination directory {path} is not empty.")
            return path

        for f in TQDM(files, desc=f"Unzipping {file} to {Path(path).resolve()}...", unit="file", disable=not progress):
            # Ensure the file is within the extract_path to avoid path traversal security vulnerability
            if ".." in Path(f).parts:
                LOGGER.warning(f"Potentially insecure file path: {f}, skipping extraction.")
                continue
            zipObj.extract(f, extract_path)

    return path  # return unzip dir



ultralytics.utils.downloads.check_disk_space(url='https://ultralytics.com/assets/coco128.zip', sf=1.5, hard=True)

जाँचें कि क्या फ़ाइल डाउनलोड और संग्रहीत करने के लिए पर्याप्त डिस्क स्थान है.

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
url str

फ़ाइल का URL. 'https:// के लिए डिफ़ॉल्टultralytics.com/संपत्ति/कोको128.zip'।

'https://ultralytics.com/assets/coco128.zip'
sf float

सुरक्षा कारक, आवश्यक मुक्त स्थान के लिए गुणक। 2.0 के लिए डिफ़ॉल्ट।

1.5
hard bool

अपर्याप्त डिस्क स्थान पर त्रुटि फेंकना है या नहीं। सही करने के लिए डिफ़ॉल्ट।

True

देता:

प्रकार विवरण: __________
bool

सच है अगर पर्याप्त डिस्क स्थान है, अन्यथा गलत।

में स्रोत कोड ultralytics/utils/downloads.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208209 210 211 212 213 214 215 216 217 218219 220 221 222223224225 226
def check_disk_space(url="https://ultralytics.com/assets/coco128.zip", sf=1.5, hard=True):
    """
    Check if there is sufficient disk space to download and store a file.

    Args:
        url (str, optional): The URL to the file. Defaults to 'https://ultralytics.com/assets/coco128.zip'.
        sf (float, optional): Safety factor, the multiplier for the required free space. Defaults to 2.0.
        hard (bool, optional): Whether to throw an error or not on insufficient disk space. Defaults to True.

    Returns:
        (bool): True if there is sufficient disk space, False otherwise.
    """
    try:
        r = requests.head(url)  # response
        assert r.status_code < 400, f"URL error for {url}: {r.status_code} {r.reason}"  # check response
    except Exception:
        return True  # requests issue, default to True

    # Check file size
    gib = 1 << 30  # bytes per GiB
    data = int(r.headers.get("Content-Length", 0)) / gib  # file size (GB)
    total, used, free = (x / gib for x in shutil.disk_usage(Path.cwd()))  # bytes

    if data * sf < free:
        return True  # sufficient space

    # Insufficient space
    text = (
        f"WARNING ⚠️ Insufficient free disk space {free:.1f} GB < {data * sf:.3f} GB required, "
        f"Please free {data * sf - free:.1f} GB additional disk space and try again."
    )
    if hard:
        raise MemoryError(text)
    LOGGER.warning(text)
    return False



ultralytics.utils.downloads.get_google_drive_file_info(link)

साझा करने योग्य Google ड्राइव फ़ाइल लिंक के लिए सीधे डाउनलोड लिंक और फ़ाइल नाम प्राप्त करता है।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
link str

Google डिस्क फ़ाइल का साझा करने योग्य लिंक.

आवश्यक

देता:

प्रकार विवरण: __________
str

Google ड्राइव फ़ाइल के लिए डायरेक्ट डाउनलोड URL.

str

Google डिस्क फ़ाइल का मूल फ़ाइल नाम. यदि फ़ाइल नाम निष्कर्षण विफल हो जाता है, तो कोई नहीं लौटाता है.

उदाहरण
from ultralytics.utils.downloads import get_google_drive_file_info

link = "https://drive.google.com/file/d/1cqT-cJgANNrhIHCrEufUYhQ4RqiWG_lJ/view?usp=drive_link"
url, filename = get_google_drive_file_info(link)
में स्रोत कोड ultralytics/utils/downloads.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258259260 261 262 263 264265 266267 268
def get_google_drive_file_info(link):
    """
    Retrieves the direct download link and filename for a shareable Google Drive file link.

    Args:
        link (str): The shareable link of the Google Drive file.

    Returns:
        (str): Direct download URL for the Google Drive file.
        (str): Original filename of the Google Drive file. If filename extraction fails, returns None.

    Example:
        ```python
        from ultralytics.utils.downloads import get_google_drive_file_info

        link = "https://drive.google.com/file/d/1cqT-cJgANNrhIHCrEufUYhQ4RqiWG_lJ/view?usp=drive_link"
        url, filename = get_google_drive_file_info(link)
        ```
    """
    file_id = link.split("/d/")[1].split("/view")[0]
    drive_url = f"https://drive.google.com/uc?export=download&id={file_id}"
    filename = None

    # Start session
    with requests.Session() as session:
        response = session.get(drive_url, stream=True)
        if "quota exceeded" in str(response.content.lower()):
            raise ConnectionError(
                emojis(
                    f"❌  Google Drive file download quota exceeded. "
                    f"Please try again later or download this file manually at {link}."
                )
            )
        for k, v in response.cookies.items():
            if k.startswith("download_warning"):
                drive_url += f"&confirm={v}"  # v is token
        cd = response.headers.get("content-disposition")
        if cd:
            filename = re.findall('filename="(.+)"', cd)[0]
    return drive_url, filename



ultralytics.utils.downloads.safe_download(url, file=None, dir=None, unzip=True, delete=False, curl=False, retry=3, min_bytes=1.0, exist_ok=False, progress=True)

URL से फ़ाइलें डाउनलोड करता है, डाउनलोड की गई फ़ाइल को पुनः प्रयास करने, अनज़िप करने और हटाने के विकल्पों के साथ।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
url str

डाउनलोड की जाने वाली फ़ाइल का URL.

आवश्यक
file str

डाउनलोड की गई फ़ाइल का फ़ाइल नाम. यदि प्रदान नहीं किया गया है, तो फ़ाइल URL के समान नाम से सहेजी जाएगी।

None
dir str

डाउनलोड की गई फ़ाइल को सहेजने के लिए निर्देशिका। यदि प्रदान नहीं किया गया है, तो फ़ाइल वर्तमान कार्यशील निर्देशिका में सहेजी जाएगी।

None
unzip bool

डाउनलोड की गई फ़ाइल को अनज़िप करना है या नहीं। डिफ़ॉल्ट: सत्य.

True
delete bool

अनज़िप करने के बाद डाउनलोड की गई फ़ाइल को हटाना है या नहीं। डिफ़ॉल्ट: गलत.

False
curl bool

डाउनलोड करने के लिए कर्ल कमांड लाइन टूल का उपयोग करना है या नहीं। डिफ़ॉल्ट: गलत.

False
retry int

विफलता के मामले में डाउनलोड का पुनः प्रयास करने की संख्या। डिफ़ॉल्ट: 3.

3
min_bytes float

बाइट्स की न्यूनतम संख्या जो डाउनलोड की गई फ़ाइल में होनी चाहिए, पर विचार किया जाना चाहिए एक सफल डाउनलोड। डिफ़ॉल्ट: 1E0.

1.0
exist_ok bool

अनजिपिंग के दौरान मौजूदा सामग्री को अधिलेखित करना है या नहीं। डिफ़ॉल्ट रूप से गलत है.

False
progress bool

डाउनलोड के दौरान प्रगति पट्टी प्रदर्शित करना है या नहीं। डिफ़ॉल्ट: सत्य.

True
उदाहरण
from ultralytics.utils.downloads import safe_download

link = "https://ultralytics.com/assets/bus.jpg"
path = safe_download(link)
में स्रोत कोड ultralytics/utils/downloads.py
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318319 320 321 322 323 324 325 326 327 328 329330 331 332333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348349 350 351 352 353 354 355 356 357 358 359360 361 362 363 364 365366367
def safe_download(
    url,
    file=None,
    dir=None,
    unzip=True,
    delete=False,
    curl=False,
    retry=3,
    min_bytes=1e0,
    exist_ok=False,
    progress=True,
):
    """
    Downloads files from a URL, with options for retrying, unzipping, and deleting the downloaded file.

    Args:
        url (str): The URL of the file to be downloaded.
        file (str, optional): The filename of the downloaded file.
            If not provided, the file will be saved with the same name as the URL.
        dir (str, optional): The directory to save the downloaded file.
            If not provided, the file will be saved in the current working directory.
        unzip (bool, optional): Whether to unzip the downloaded file. Default: True.
        delete (bool, optional): Whether to delete the downloaded file after unzipping. Default: False.
        curl (bool, optional): Whether to use curl command line tool for downloading. Default: False.
        retry (int, optional): The number of times to retry the download in case of failure. Default: 3.
        min_bytes (float, optional): The minimum number of bytes that the downloaded file should have, to be considered
            a successful download. Default: 1E0.
        exist_ok (bool, optional): Whether to overwrite existing contents during unzipping. Defaults to False.
        progress (bool, optional): Whether to display a progress bar during the download. Default: True.

    Example:
        ```python
        from ultralytics.utils.downloads import safe_download

        link = "https://ultralytics.com/assets/bus.jpg"
        path = safe_download(link)
        ```
    """
    gdrive = url.startswith("https://drive.google.com/")  # check if the URL is a Google Drive link
    if gdrive:
        url, file = get_google_drive_file_info(url)

    f = Path(dir or ".") / (file or url2file(url))  # URL converted to filename
    if "://" not in str(url) and Path(url).is_file():  # URL exists ('://' check required in Windows Python<3.10)
        f = Path(url)  # filename
    elif not f.is_file():  # URL and file do not exist
        desc = f"Downloading {url if gdrive else clean_url(url)} to '{f}'"
        LOGGER.info(f"{desc}...")
        f.parent.mkdir(parents=True, exist_ok=True)  # make directory if missing
        check_disk_space(url)
        for i in range(retry + 1):
            try:
                if curl or i > 0:  # curl download with retry, continue
                    s = "sS" * (not progress)  # silent
                    r = subprocess.run(["curl", "-#", f"-{s}L", url, "-o", f, "--retry", "3", "-C", "-"]).returncode
                    assert r == 0, f"Curl return value {r}"
                else:  # urllib download
                    method = "torch"
                    if method == "torch":
                        torch.hub.download_url_to_file(url, f, progress=progress)
                    else:
                        with request.urlopen(url) as response, TQDM(
                            total=int(response.getheader("Content-Length", 0)),
                            desc=desc,
                            disable=not progress,
                            unit="B",
                            unit_scale=True,
                            unit_divisor=1024,
                        ) as pbar:
                            with open(f, "wb") as f_opened:
                                for data in response:
                                    f_opened.write(data)
                                    pbar.update(len(data))

                if f.exists():
                    if f.stat().st_size > min_bytes:
                        break  # success
                    f.unlink()  # remove partial downloads
            except Exception as e:
                if i == 0 and not is_online():
                    raise ConnectionError(emojis(f"❌  Download failure for {url}. Environment is not online.")) from e
                elif i >= retry:
                    raise ConnectionError(emojis(f"❌  Download failure for {url}. Retry limit reached.")) from e
                LOGGER.warning(f"⚠️ Download failure, retrying {i + 1}/{retry} {url}...")

    if unzip and f.exists() and f.suffix in ("", ".zip", ".tar", ".gz"):
        from zipfile import is_zipfile

        unzip_dir = (dir or f.parent).resolve()  # unzip to dir if provided else unzip in place
        if is_zipfile(f):
            unzip_dir = unzip_file(file=f, path=unzip_dir, exist_ok=exist_ok, progress=progress)  # unzip
        elif f.suffix in (".tar", ".gz"):
            LOGGER.info(f"Unzipping {f} to {unzip_dir}...")
            subprocess.run(["tar", "xf" if f.suffix == ".tar" else "xfz", f, "--directory", unzip_dir], check=True)
        if delete:
            f.unlink()  # remove zip
        return unzip_dir



ultralytics.utils.downloads.get_github_assets(repo='ultralytics/assets', version='latest', retry=False)

निर्दिष्ट संस्करण के टैग और संपत्ति को GitHub रिपॉजिटरी से पुनः प्राप्त करें। यदि संस्करण निर्दिष्ट नहीं है, तो फ़ंक्शन नवीनतम रिलीज़ एसेट प्राप्त करता है।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
repo str

GitHub रिपॉजिटरी 'owner/repo' प्रारूप में। ' के लिए चूकultralytics/assets'का उपयोग करें।

'ultralytics/assets'
version str

से संपत्ति लाने के लिए रिलीज संस्करण। 'नवीनतम' के लिए डिफ़ॉल्ट।

'latest'
retry bool

विफलता के मामले में अनुरोध का पुनः प्रयास करने के लिए ध्वजांकित करें। डिफ़ॉल्ट रूप से गलत है.

False

देता:

प्रकार विवरण: __________
tuple

एक टपल जिसमें रिलीज़ टैग और एसेट नामों की सूची होती है.

उदाहरण
tag, assets = get_github_assets(repo='ultralytics/assets', version='latest')
में स्रोत कोड ultralytics/utils/downloads.py
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396397398 399
def get_github_assets(repo="ultralytics/assets", version="latest", retry=False):
    """
    Retrieve the specified version's tag and assets from a GitHub repository. If the version is not specified, the
    function fetches the latest release assets.

    Args:
        repo (str, optional): The GitHub repository in the format 'owner/repo'. Defaults to 'ultralytics/assets'.
        version (str, optional): The release version to fetch assets from. Defaults to 'latest'.
        retry (bool, optional): Flag to retry the request in case of a failure. Defaults to False.

    Returns:
        (tuple): A tuple containing the release tag and a list of asset names.

    Example:
        ```python
        tag, assets = get_github_assets(repo='ultralytics/assets', version='latest')
        ```
    """

    if version != "latest":
        version = f"tags/{version}"  # i.e. tags/v6.2
    url = f"https://api.github.com/repos/{repo}/releases/{version}"
    r = requests.get(url)  # github api
    if r.status_code != 200 and r.reason != "rate limit exceeded" and retry:  # failed and not 403 rate limit exceeded
        r = requests.get(url)  # try again
    if r.status_code != 200:
        LOGGER.warning(f"⚠️ GitHub assets check failure for {url}: {r.status_code} {r.reason}")
        return "", []
    data = r.json()
    return data["tag_name"], [x["name"] for x in data["assets"]]  # tag, assets i.e. ['yolov8n.pt', 'yolov8s.pt', ...]



ultralytics.utils.downloads.attempt_download_asset(file, repo='ultralytics/assets', release='v8.1.0', **kwargs)

GitHub रिलीज़ एसेट से फ़ाइल डाउनलोड करने का प्रयास करें यदि यह स्थानीय रूप से नहीं मिली है। फ़ंक्शन फ़ाइल के लिए जाँच करता है स्थानीय रूप से पहले, फिर इसे निर्दिष्ट GitHub रिपॉजिटरी रिलीज़ से डाउनलोड करने का प्रयास करता है।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
file str | Path

डाउनलोड किया जाने वाला फ़ाइल नाम या फ़ाइल पथ.

आवश्यक
repo str

GitHub रिपॉजिटरी 'owner/repo' प्रारूप में। ' के लिए चूकultralytics/assets'का उपयोग करें।

'ultralytics/assets'
release str

डाउनलोड किया जाने वाला विशिष्ट रिलीज़ संस्करण। 'v8.1.0' के लिए डिफ़ॉल्ट।

'v8.1.0'
**kwargs dict

डाउनलोड प्रक्रिया के लिए अतिरिक्त कीवर्ड तर्क।

{}

देता:

प्रकार विवरण: __________
str

डाउनलोड की गई फ़ाइल का पथ.

उदाहरण
file_path = attempt_download_asset('yolov5s.pt', repo='ultralytics/assets', release='latest')
में स्रोत कोड ultralytics/utils/downloads.py
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418419 420 421 422 423 424 425 426 427 428429430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448449 450451 452 453
def attempt_download_asset(file, repo="ultralytics/assets", release="v8.1.0", **kwargs):
    """
    Attempt to download a file from GitHub release assets if it is not found locally. The function checks for the file
    locally first, then tries to download it from the specified GitHub repository release.

    Args:
        file (str | Path): The filename or file path to be downloaded.
        repo (str, optional): The GitHub repository in the format 'owner/repo'. Defaults to 'ultralytics/assets'.
        release (str, optional): The specific release version to be downloaded. Defaults to 'v8.1.0'.
        **kwargs (dict): Additional keyword arguments for the download process.

    Returns:
        (str): The path to the downloaded file.

    Example:
        ```python
        file_path = attempt_download_asset('yolov5s.pt', repo='ultralytics/assets', release='latest')
        ```
    """
    from ultralytics.utils import SETTINGS  # scoped for circular import

    # YOLOv3/5u updates
    file = str(file)
    file = checks.check_yolov5u_filename(file)
    file = Path(file.strip().replace("'", ""))
    if file.exists():
        return str(file)
    elif (SETTINGS["weights_dir"] / file).exists():
        return str(SETTINGS["weights_dir"] / file)
    else:
        # URL specified
        name = Path(parse.unquote(str(file))).name  # decode '%2F' to '/' etc.
        download_url = f"https://github.com/{repo}/releases/download"
        if str(file).startswith(("http:/", "https:/")):  # download
            url = str(file).replace(":/", "://")  # Pathlib turns :// -> :/
            file = url2file(name)  # parse authentication https://url.com/file.txt?auth...
            if Path(file).is_file():
                LOGGER.info(f"Found {clean_url(url)} locally at {file}")  # file already exists
            else:
                safe_download(url=url, file=file, min_bytes=1e5, **kwargs)

        elif repo == GITHUB_ASSETS_REPO and name in GITHUB_ASSETS_NAMES:
            safe_download(url=f"{download_url}/{release}/{name}", file=file, min_bytes=1e5, **kwargs)

        else:
            tag, assets = get_github_assets(repo, release)
            if not assets:
                tag, assets = get_github_assets(repo)  # latest release
            if name in assets:
                safe_download(url=f"{download_url}/{tag}/{name}", file=file, min_bytes=1e5, **kwargs)

        return str(file)



ultralytics.utils.downloads.download(url, dir=Path.cwd(), unzip=True, delete=False, curl=False, threads=1, retry=3, exist_ok=False)

निर्दिष्ट URL से फ़ाइलों को किसी दिए गए निर्देशिका में डाउनलोड करता है। समवर्ती डाउनलोड का समर्थन करता है यदि कई धागे हैं निर्दिष्ट।

पैरामीटर:

नाम प्रकार विवरण: __________ चूक
url str | list

डाउनलोड की जाने वाली फ़ाइलों का URL या URL की सूची.

आवश्यक
dir Path

निर्देशिका जहां फाइलें सहेजी जाएंगी। वर्तमान कार्यशील निर्देशिका के लिए डिफ़ॉल्ट।

cwd()
unzip bool

डाउनलोड करने के बाद फ़ाइलों को अनज़िप करने के लिए ध्वज। सही करने के लिए डिफ़ॉल्ट।

True
delete bool

निष्कर्षण के बाद ज़िप फ़ाइलों को हटाने के लिए ध्वज। डिफ़ॉल्ट रूप से गलत है.

False
curl bool

डाउनलोड करने के लिए कर्ल का उपयोग करने के लिए ध्वज। डिफ़ॉल्ट रूप से गलत है.

False
threads int

समवर्ती डाउनलोड के लिए उपयोग करने के लिए धागे की संख्या। 1 के लिए डिफ़ॉल्ट।

1
retry int

डाउनलोड विफलता के मामले में पुनः प्रयास की संख्या। 3 के लिए डिफ़ॉल्ट।

3
exist_ok bool

अनजिपिंग के दौरान मौजूदा सामग्री को अधिलेखित करना है या नहीं। डिफ़ॉल्ट रूप से गलत है.

False
उदाहरण
download('https://ultralytics.com/assets/example.zip', dir='path/to/dir', unzip=True)
में स्रोत कोड ultralytics/utils/downloads.py
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486487 488489 490 491 492 493 494 495 496 497
def download(url, dir=Path.cwd(), unzip=True, delete=False, curl=False, threads=1, retry=3, exist_ok=False):
    """
    Downloads files from specified URLs to a given directory. Supports concurrent downloads if multiple threads are
    specified.

    Args:
        url (str | list): The URL or list of URLs of the files to be downloaded.
        dir (Path, optional): The directory where the files will be saved. Defaults to the current working directory.
        unzip (bool, optional): Flag to unzip the files after downloading. Defaults to True.
        delete (bool, optional): Flag to delete the zip files after extraction. Defaults to False.
        curl (bool, optional): Flag to use curl for downloading. Defaults to False.
        threads (int, optional): Number of threads to use for concurrent downloads. Defaults to 1.
        retry (int, optional): Number of retries in case of download failure. Defaults to 3.
        exist_ok (bool, optional): Whether to overwrite existing contents during unzipping. Defaults to False.

    Example:
        ```python
        download('https://ultralytics.com/assets/example.zip', dir='path/to/dir', unzip=True)
        ```
    """
    dir = Path(dir)
    dir.mkdir(parents=True, exist_ok=True)  # make directory
    if threads > 1:
        with ThreadPool(threads) as pool:
            pool.map(
                lambda x: safe_download(
                    url=x[0],
                    dir=x[1],
                    unzip=unzip,
                    delete=delete,
                    curl=curl,
                    retry=retry,
                    exist_ok=exist_ok,
                    progress=threads <= 1,
                ),
                zip(url, repeat(dir)),
            )
            pool.close()
            pool.join()
    else:
        for u in [url] if isinstance(url, (str, Path)) else url:
            safe_download(url=u, dir=dir, unzip=unzip, delete=delete, curl=curl, retry=retry, exist_ok=exist_ok)





2023-11-12 बनाया गया, अपडेट किया गया 2023-11-25
लेखक: ग्लेन-जोचर (3), लाफिंग-क्यू (1)