Referencia para ultralytics/utils/downloads.py
Nota
Este archivo está disponible en https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/downloads .py. Si detectas algún problema, por favor, ayuda a solucionarlo contribuyendo con una Pull Request 🛠️. ¡Gracias 🙏!
ultralytics.utils.downloads.is_url(url, check=False)
Valida si la cadena dada es una URL y, opcionalmente, comprueba si la URL existe en Internet.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
url |
str
|
La cadena que debe validarse como URL. |
necesario |
check |
bool
|
Si es True, realiza una comprobación adicional para ver si la URL existe en línea. Por defecto es Verdadero. |
False
|
Devuelve:
Tipo | Descripción |
---|---|
bool
|
Devuelve True si la URL es válida. Si 'comprobar' es True, también devuelve True si la URL existe en línea. En caso contrario, devuelve False. |
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.delete_dsstore(path, files_to_delete=('.DS_Store', '__MACOSX'))
Elimina todos los archivos ".DS_store" de un directorio especificado.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
path |
str
|
La ruta del directorio donde deben borrarse los archivos ".DS_store". |
necesario |
files_to_delete |
tuple
|
Los archivos que hay que borrar. |
('.DS_Store', '__MACOSX')
|
Nota
Los archivos ".DS_store" son creados por el sistema operativo de Apple y contienen metadatos sobre carpetas y archivos. Son son archivos ocultos del sistema y pueden causar problemas al transferir archivos entre distintos sistemas operativos.
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.zip_directory(directory, compress=True, exclude=('.DS_Store', '__MACOSX'), progress=True)
Comprime el contenido de un directorio, excluyendo los archivos que contengan cadenas en la lista de exclusión. El archivo zip resultante con el nombre del directorio y se coloca junto a él.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
directory |
str | Path
|
La ruta al directorio que se va a comprimir. |
necesario |
compress |
bool
|
Si comprimir o no los archivos al comprimirlos. Por defecto es Verdadero. |
True
|
exclude |
tuple
|
Una tupla de cadenas de nombres de archivo a excluir. Por defecto es ('.DS_Store', '__MACOSX'). |
('.DS_Store', '__MACOSX')
|
progress |
bool
|
Si se muestra una barra de progreso. Por defecto es Verdadero. |
True
|
Devuelve:
Tipo | Descripción |
---|---|
Path
|
La ruta al archivo zip resultante. |
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.unzip_file(file, path=None, exclude=('.DS_Store', '__MACOSX'), exist_ok=False, progress=True)
Descomprime un archivo *.zip en la ruta especificada, excluyendo los archivos que contengan cadenas en la lista de exclusión.
Si el archivo zip no contiene un único directorio de nivel superior, la función creará un nuevo con el mismo nombre que el archivo zip (sin la extensión) para extraer su contenido. Si no se proporciona una ruta, la función utilizará el directorio padre del archivo zip como ruta por defecto.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
file |
str
|
La ruta al archivo zip que se va a extraer. |
necesario |
path |
str
|
La ruta a la que extraer el archivo zip. Por defecto es Ninguno. |
None
|
exclude |
tuple
|
Una tupla de cadenas de nombres de archivo a excluir. Por defecto es ('.DS_Store', '__MACOSX'). |
('.DS_Store', '__MACOSX')
|
exist_ok |
bool
|
Si se sobrescriben los contenidos existentes en caso de que existan. Por defecto es Falso. |
False
|
progress |
bool
|
Si se muestra una barra de progreso. Por defecto es Verdadero. |
True
|
Aumenta:
Tipo | Descripción |
---|---|
BadZipFile
|
Si el archivo proporcionado no existe o no es un archivo zip válido. |
Devuelve:
Tipo | Descripción |
---|---|
Path
|
La ruta al directorio donde se extrajo el archivo zip. |
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.check_disk_space(url='https://ultralytics.com/assets/coco128.zip', path=Path.cwd(), sf=1.5, hard=True)
Comprueba si hay suficiente espacio en disco para descargar y almacenar un archivo.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
url |
str
|
La URL del archivo. Por defecto es 'https://ultralytics.com/assets/coco128.zip'. |
'https://ultralytics.com/assets/coco128.zip'
|
path |
str | Path
|
La ruta o unidad en la que comprobar el espacio libre disponible. |
cwd()
|
sf |
float
|
Factor de seguridad, el multiplicador del espacio libre necesario. Por defecto es 2,0. |
1.5
|
hard |
bool
|
Si se lanza un error o no en caso de espacio insuficiente en disco. Por defecto es Verdadero. |
True
|
Devuelve:
Tipo | Descripción |
---|---|
bool
|
Verdadero si hay suficiente espacio en disco, Falso en caso contrario. |
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.get_google_drive_file_info(link)
Recupera el enlace de descarga directa y el nombre de archivo de un enlace de archivo compartible de Google Drive.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
link |
str
|
El enlace compartible del archivo de Google Drive. |
necesario |
Devuelve:
Tipo | Descripción |
---|---|
str
|
URL de descarga directa del archivo de Google Drive. |
str
|
Nombre original del archivo de Google Drive. Si la extracción del nombre de archivo falla, devuelve Ninguno. |
Ejemplo
Código fuente en ultralytics/utils/downloads.py
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)
Descarga archivos desde una URL, con opciones para reintentar, descomprimir y eliminar el archivo descargado.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
url |
str
|
La URL del archivo que se va a descargar. |
necesario |
file |
str
|
El nombre del archivo descargado. Si no se proporciona, el archivo se guardará con el mismo nombre que la URL. |
None
|
dir |
str
|
El directorio donde guardar el archivo descargado. Si no se proporciona, el archivo se guardará en el directorio de trabajo actual. |
None
|
unzip |
bool
|
Si descomprimir o no el archivo descargado. Por defecto: Verdadero. |
True
|
delete |
bool
|
Si eliminar el archivo descargado después de descomprimirlo. Por defecto: Falso. |
False
|
curl |
bool
|
Si utilizar la herramienta de línea de comandos curl para la descarga. Por defecto: Falso. |
False
|
retry |
int
|
El número de veces que se debe reintentar la descarga en caso de fallo. Por defecto: 3. |
3
|
min_bytes |
float
|
El número mínimo de bytes que debe tener el archivo descargado, para que se considere una descarga correcta. Por defecto: 1E0. |
1.0
|
exist_ok |
bool
|
Si se sobrescriben los contenidos existentes al descomprimir. Por defecto es Falso. |
False
|
progress |
bool
|
Si se muestra una barra de progreso durante la descarga. Por defecto: Verdadero. |
True
|
Ejemplo
Código fuente en ultralytics/utils/downloads.py
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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
|
ultralytics.utils.downloads.get_github_assets(repo='ultralytics/assets', version='latest', retry=False)
Recupera la etiqueta y los activos de la versión especificada de un repositorio de GitHub. Si no se especifica la versión, la función recupera los activos de la última versión.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
repo |
str
|
El repositorio de GitHub en el formato 'owner/repo'. Por defecto es 'ultralytics/assets'. |
'ultralytics/assets'
|
version |
str
|
La versión de lanzamiento de la que obtener los activos. Por defecto es "última". |
'latest'
|
retry |
bool
|
Bandera para reintentar la petición en caso de fallo. Por defecto es Falso. |
False
|
Devuelve:
Tipo | Descripción |
---|---|
tuple
|
Una tupla que contiene la etiqueta de publicación y una lista de nombres de activos. |
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.attempt_download_asset(file, repo='ultralytics/assets', release='v8.2.0', **kwargs)
Intenta descargar un archivo de los activos de publicación de GitHub si no se encuentra localmente. La función busca el archivo localmente primero, y luego intenta descargarlo de la versión del repositorio de GitHub especificada.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
file |
str | Path
|
El nombre o la ruta del archivo que se va a descargar. |
necesario |
repo |
str
|
El repositorio de GitHub en el formato 'owner/repo'. Por defecto es 'ultralytics/assets'. |
'ultralytics/assets'
|
release |
str
|
La versión específica a descargar. Por defecto es 'v8.2.0'. |
'v8.2.0'
|
**kwargs |
any
|
Argumentos de palabras clave adicionales para el proceso de descarga. |
{}
|
Devuelve:
Tipo | Descripción |
---|---|
str
|
La ruta al archivo descargado. |
Ejemplo
Código fuente en ultralytics/utils/downloads.py
ultralytics.utils.downloads.download(url, dir=Path.cwd(), unzip=True, delete=False, curl=False, threads=1, retry=3, exist_ok=False)
Descarga archivos de las URL especificadas a un directorio determinado. Admite descargas simultáneas si se especifican varios subprocesos. hilos.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
url |
str | list
|
La URL o lista de URL de los archivos que se van a descargar. |
necesario |
dir |
Path
|
El directorio donde se guardarán los archivos. Por defecto es el directorio de trabajo actual. |
cwd()
|
unzip |
bool
|
Bandera para descomprimir los archivos después de descargarlos. Por defecto es Verdadero. |
True
|
delete |
bool
|
Bandera para borrar los archivos zip después de la extracción. Por defecto es Falso. |
False
|
curl |
bool
|
Bandera para utilizar curl en la descarga. Por defecto es Falso. |
False
|
threads |
int
|
Número de hilos a utilizar para descargas concurrentes. Por defecto es 1. |
1
|
retry |
int
|
Número de reintentos en caso de fallo de descarga. Por defecto es 3. |
3
|
exist_ok |
bool
|
Si se sobrescriben los contenidos existentes al descomprimir. Por defecto es Falso. |
False
|