参考 ultralytics/utils/downloads.py
注
このファイルはhttps://github.com/ultralytics/ultralytics/blob/main/ ultralytics/utils/downloads .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございました!
ultralytics.utils.downloads.is_url(url, check=False)
与えられた文字列がURLであるかどうかを検証し、オプションでそのURLがオンラインに存在するかどうかをチェックします。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
url |
str
|
URLとして検証される文字列。 |
必須 |
check |
bool
|
Trueの場合、そのURLがオンラインに存在するかどうかの追加チェックを行う。 デフォルトはTrue。 |
False
|
リターンズ
タイプ | 説明 |
---|---|
bool
|
有効なURLに対してTrueを返す。check'がTrueの場合、そのURLがオンラインに存在する場合もTrueを返す。 そうでない場合はFalseを返す。 |
ソースコード ultralytics/utils/downloads.py
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')
|
注
".DS_store "ファイルはアップルのオペレーティングシステムによって作成され、フォルダやファイルに関するメタデータを含んでいます。これらは 隠しシステムファイルであり、異なるオペレーティングシステム間でファイルを転送する際に問題を引き起こす可能性があります。
ソースコード ultralytics/utils/downloads.py
ultralytics.utils.downloads.zip_directory(directory, compress=True, exclude=('.DS_Store', '__MACOSX'), progress=True)
除外リストに含まれる文字列を含むファイルを除外して、ディレクトリの内容をZIP圧縮する。出来上がったzipファイルは ディレクトリにちなんで命名され、ディレクトリと一緒に置かれます。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
directory |
str | Path
|
zip圧縮されるディレクトリへのパス。 |
必須 |
compress |
bool
|
zip圧縮時にファイルを圧縮するかどうか。デフォルトはTrue。 |
True
|
exclude |
tuple
|
除外するファイル名文字列のタプル。デフォルトは ('.DS_Store', '__MACOSX') です。 |
('.DS_Store', '__MACOSX')
|
progress |
bool
|
プログレス・バーを表示するかどうか。デフォルトはTrue。 |
True
|
リターンズ
タイプ | 説明 |
---|---|
Path
|
結果のZIPファイルへのパス。 |
ソースコード ultralytics/utils/downloads.py
ultralytics.utils.downloads.unzip_file(file, path=None, exclude=('.DS_Store', '__MACOSX'), exist_ok=False, progress=True)
除外リストにある文字列を含むファイルを除外して、*.zip ファイルを指定されたパスに解凍する。
zipfile がトップレベルのディレクトリをひとつも含んでいない場合、 この関数は zipfile と同じ名前 (拡張子なし) で新しい ディレクトリを作成します。 パスが与えられない場合、この関数は zipfile の親ディレクトリをデフォルトパスとして使用する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
file |
str
|
解凍するzipファイルのパス。 |
必須 |
path |
str
|
zipファイルを展開するパス。デフォルトはNone。 |
None
|
exclude |
tuple
|
除外するファイル名文字列のタプル。デフォルトは ('.DS_Store', '__MACOSX') です。 |
('.DS_Store', '__MACOSX')
|
exist_ok |
bool
|
既存のコンテンツが存在する場合に上書きするかどうか。デフォルトは False。 |
False
|
progress |
bool
|
プログレス・バーを表示するかどうか。デフォルトはTrue。 |
True
|
レイズ
タイプ | 説明 |
---|---|
BadZipFile
|
提供されたファイルが存在しないか、有効なzipファイルでない場合。 |
リターンズ
タイプ | 説明 |
---|---|
Path
|
zipファイルを解凍したディレクトリへのパス。 |
ソースコード 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)
ファイルをダウンロードして保存するのに十分なディスク容量があるかどうかを確認する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
url |
str
|
ファイルの URL。デフォルトは 'https://ultralytics.com/assets/coco128.zip' です。 |
'https://ultralytics.com/assets/coco128.zip'
|
path |
str | Path
|
空き容量を確認するパスまたはドライブ。 |
cwd()
|
sf |
float
|
安全係数、必要な空きスペースの倍率。デフォルトは2.0。 |
1.5
|
hard |
bool
|
ディスク容量不足時にエラーを投げるかどうか。デフォルトはTrue。 |
True
|
リターンズ
タイプ | 説明 |
---|---|
bool
|
十分なディスク容量があれば真、なければ偽。 |
ソースコード ultralytics/utils/downloads.py
ultralytics.utils.downloads.get_google_drive_file_info(link)
共有可能なGoogle Driveファイルリンクの直接ダウンロードリンクとファイル名を取得します。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
link |
str
|
グーグルドライブファイルの共有リンク。 |
必須 |
リターンズ
タイプ | 説明 |
---|---|
str
|
Googleドライブファイルの直接ダウンロードURL。 |
str
|
Google Drive ファイルの元のファイル名。ファイル名の抽出に失敗した場合は None を返します。 |
例
ソースコード 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)
URLからファイルをダウンロードし、再試行、解凍、ダウンロードしたファイルを削除するオプションがあります。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
url |
str
|
ダウンロードするファイルのURL。 |
必須 |
file |
str
|
ダウンロードしたファイルのファイル名。 指定しない場合、ファイルはURLと同じ名前で保存されます。 |
None
|
dir |
str
|
ダウンロードしたファイルを保存するディレクトリ。 指定しない場合、ファイルは現在の作業ディレクトリに保存されます。 |
None
|
unzip |
bool
|
ダウンロードしたファイルを解凍するかどうか。デフォルトはTrue。 |
True
|
delete |
bool
|
ダウンロードしたファイルを解凍後に削除するかどうか。デフォルト:False。 |
False
|
curl |
bool
|
ダウンロードに curl コマンドラインツールを使うかどうか。デフォルト:False |
False
|
retry |
int
|
ダウンロードに失敗した場合に再試行する回数。デフォルト:3。 |
3
|
min_bytes |
float
|
ダウンロードが成功したとみなされるために、ダウンロードされるファイルが持つべき最小バイト数。 を指定する。デフォルト:1E0。 |
1.0
|
exist_ok |
bool
|
解凍時に既存のコンテンツを上書きするかどうか。デフォルトは False。 |
False
|
progress |
bool
|
ダウンロード中にプログレスバーを表示するかどうか。デフォルトはTrue。 |
True
|
例
ソースコード 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)
指定したバージョンのタグとアセットを GitHub リポジトリから取得します。バージョンが指定されていない場合は 関数は最新のリリースアセットを取得します。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
repo |
str
|
GitHubのリポジトリを'owner/repo'の形式で指定する。デフォルトは 'ultralytics/assets' です。 |
'ultralytics/assets'
|
version |
str
|
アセットを取得するリリースバージョン。デフォルトは 'latest' です。 |
'latest'
|
retry |
bool
|
リクエストが失敗した場合に再試行するフラグ。デフォルトは False です。 |
False
|
リターンズ
タイプ | 説明 |
---|---|
tuple
|
リリースタグとアセット名のリストを含むタプル。 |
ソースコード ultralytics/utils/downloads.py
ultralytics.utils.downloads.attempt_download_asset(file, repo='ultralytics/assets', release='v8.2.0', **kwargs)
GitHub リリースアセットからファイルがローカルに見つからない場合にダウンロードを試みます。この関数は をまずローカルでチェックし、それから指定した GitHub リポジトリのリリースからダウンロードしようとします。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
file |
str | Path
|
ダウンロードするファイル名またはファイルパス。 |
必須 |
repo |
str
|
GitHubのリポジトリを'owner/repo'の形式で指定する。デフォルトは 'ultralytics/assets' です。 |
'ultralytics/assets'
|
release |
str
|
ダウンロードする特定のリリース・バージョン。デフォルトは 'v8.2.0' です。 |
'v8.2.0'
|
**kwargs |
any
|
ダウンロード処理のための追加キーワード引数。 |
{}
|
リターンズ
タイプ | 説明 |
---|---|
str
|
ダウンロードしたファイルのパス。 |
ソースコード 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)
指定されたURLから指定されたディレクトリにファイルをダウンロードする。複数のスレッドが指定されている場合は、同時ダウンロードをサポートします。 指定された場合、同時ダウンロードをサポートします。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
url |
str | list
|
ダウンロードするファイルのURLまたはURLのリスト。 |
必須 |
dir |
Path
|
ファイルを保存するディレクトリ。デフォルトは現在の作業ディレクトリです。 |
cwd()
|
unzip |
bool
|
ダウンロード後にファイルを解凍するフラグ。デフォルトはTrue。 |
True
|
delete |
bool
|
解凍後にzipファイルを削除するかどうかのフラグ。デフォルトはFalse。 |
False
|
curl |
bool
|
ダウンロードにcurlを使うかどうかのフラグ。デフォルトは False です。 |
False
|
threads |
int
|
同時ダウンロードに使用するスレッド数。デフォルトは1。 |
1
|
retry |
int
|
ダウンロード失敗時の再試行回数。デフォルトは3。 |
3
|
exist_ok |
bool
|
解凍時に既存のコンテンツを上書きするかどうか。デフォルトは False。 |
False
|