参考 ultralytics/utils/checks.py
注
このファイルはhttps://github.com/ultralytics/ultralytics/blob/main/ ultralytics/utils/checks .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございました!
ultralytics.utils.checks.parse_requirements(file_path=ROOT.parent / 'requirements.txt', package='')
requirements.txtファイルを解析し、'#'で始まる行と'#'以降のテキストを無視する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
file_path |
Path
|
requirements.txtファイルへのパス。 |
parent / 'requirements.txt'
|
package |
str
|
Python つまり、package='ultralytics'. |
''
|
リターンズ
タイプ | 説明 |
---|---|
List[Dict[str, str]]
|
を持つ辞書として解析された要件のリスト。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.parse_version(version='0.0.0')
バージョン文字列を整数のタプルに変換し、バージョンに付随する数値以外の文字列は無視する。この 関数は、非推奨の 'pkg_resources.parse_version(v)' を置き換えるものです。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
version |
str
|
バージョン文字列、すなわち「2.0.1+cpu |
'0.0.0'
|
リターンズ
タイプ | 説明 |
---|---|
tuple
|
バージョンの数値部分と追加文字列を表す整数のタプル。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.is_ascii(s)
文字列がASCII文字のみで構成されているかどうかを調べる。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
s |
str
|
チェックする文字列。 |
必須 |
リターンズ
タイプ | 説明 |
---|---|
bool
|
文字列がASCII文字のみで構成されている場合は真、そうでない場合は偽。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_imgsz(imgsz, stride=32, min_dim=1, max_dim=2, floor=0)
画像サイズが各次元で与えられたストライドの倍数であることを確認する。画像サイズが の倍数でない場合は,与えられたフロア値以上の最も近い倍数に更新する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
imgsz |
int | cList[int]
|
画像サイズ。 |
必須 |
stride |
int
|
ストライド値。 |
32
|
min_dim |
int
|
最小寸法数。 |
1
|
max_dim |
int
|
最大寸法数。 |
2
|
floor |
int
|
画像サイズの最小許容値。 |
0
|
リターンズ
タイプ | 説明 |
---|---|
List[int]
|
画像サイズを更新しました。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_version(current='0.0.0', required='0.0.0', name='version', hard=False, verbose=False, msg='')
現在のバージョンを必要なバージョンまたは範囲と照合する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
current |
str
|
現在のバージョン、またはバージョンを取得するパッケージ名。 |
'0.0.0'
|
required |
str
|
必要なバージョンまたは範囲(pip形式)。 |
'0.0.0'
|
name |
str
|
警告メッセージに使用する名前。 |
'version'
|
hard |
bool
|
True の場合、要件が満たされていなければ AssertionError を発生させます。 |
False
|
verbose |
bool
|
Trueの場合、要件を満たさない場合に警告メッセージを表示します。 |
False
|
msg |
str
|
冗長な場合に表示する追加メッセージ。 |
''
|
リターンズ
タイプ | 説明 |
---|---|
bool
|
要件が満たされていれば真、そうでなければ偽。 |
例
# Check if current version is exactly 22.04
check_version(current='22.04', required='==22.04')
# Check if current version is greater than or equal to 22.04
check_version(current='22.10', required='22.04') # assumes '>=' inequality if none passed
# Check if current version is less than or equal to 22.04
check_version(current='22.04', required='<=22.04')
# Check if current version is between 20.04 (inclusive) and 22.04 (exclusive)
check_version(current='21.10', required='>20.04,<22.04')
ソースコード ultralytics/utils/checks.py
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 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 |
|
ultralytics.utils.checks.check_latest_pypi_version(package_name='ultralytics')
ダウンロードやインストールをせずに、PyPI パッケージの最新バージョンを返します。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
package_name |
str
|
最新バージョンを探すパッケージ名。 |
'ultralytics'
|
リターンズ
タイプ | 説明 |
---|---|
str
|
パッケージの最新バージョン。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_pip_update_available()
ultralytics パッケージの新しいバージョンが PyPI で利用可能かどうかを調べます。
リターンズ
タイプ | 説明 |
---|---|
bool
|
アップデートがあれば真、なければ偽。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_font(font='Arial.ttf')
フォントをローカルに検索するか、まだ存在しない場合はユーザーの設定ディレクトリにダウンロードする。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
font |
str
|
フォントのパスまたは名前。 |
'Arial.ttf'
|
リターンズ
名称 | タイプ | 説明 |
---|---|---|
file |
Path
|
フォントファイルのパスを解決しました。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_python(minimum='3.8.0')
現在のpython のバージョンを、必要な最小バージョンと照合する。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
minimum |
str
|
必要な最小バージョンはpython 。 |
'3.8.0'
|
リターンズ
タイプ | 説明 |
---|---|
bool
|
インストールされているPython のバージョンが最小制約を満たしているかどうか。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_requirements(requirements=ROOT.parent / 'requirements.txt', exclude=(), install=True, cmds='')
インストールされた依存関係がYOLOv8 の要件を満たしているかどうかを確認し、必要であれば自動更新を試みる。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
requirements |
Union[Path, str, List[str]]
|
requirements.txtファイルへのパス。 へのパス、文字列としての単一のパッケージ要件、または文字列としてのパッケージ要件のリスト。 |
parent / 'requirements.txt'
|
exclude |
Tuple[str]
|
チェックから除外するパッケージ名のタプル。 |
()
|
install |
bool
|
Trueの場合、要件を満たしていないパッケージの自動更新を試みます。 |
True
|
cmds |
str
|
自動更新時にpip installコマンドに渡す追加コマンド。 |
''
|
例
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_torchvision()
インストールされているPyTorch と Torchvision のバージョンをチェックし、互換性があることを確認します。
この関数はインストールされているPyTorch と Torchvision のバージョンをチェックし、以下の互換性表に従って互換性がない場合に警告を発します。 に基づいて提供される互換性テーブルに従って互換性がない場合に警告します: https://github.com/pytorch/vision#installation.
互換性テーブルは辞書で、キーはPyTorch バージョン、値は互換性のあるTorchvisionバージョンのリストです。 のリストです。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_suffix(file='yolov8n.pt', suffix='.pt', msg='')
許容可能なサフィックスがあるか、ファイルをチェックする。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolov5u_filename(file, verbose=True)
従来のYOLOv5 ファイル名を最新のYOLOv5u ファイル名に置き換える。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_model_file_from_stem(model='yolov8n')
有効なモデルステムからモデルファイル名を返します。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_file(file, suffix='', download=True, hard=True)
ファイルを検索/ダウンロードし(必要な場合)、パスを返します。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_yaml(file, suffix=('.yaml', '.yml'), hard=True)
ultralytics.utils.checks.check_is_path_safe(basedir, path)
パストラバーサルを防ぐために、解決されたパスが意図したディレクトリの下にあるかどうかをチェックする。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
basedir |
Path | str
|
目的のディレクトリ。 |
必須 |
path |
Path | str
|
チェックするパス。 |
必須 |
リターンズ
タイプ | 説明 |
---|---|
bool
|
パスが安全であれば真、そうでなければ偽。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_imshow(warn=False)
画像が表示できる環境かどうかを確認する。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolo(verbose=True, device='')
人間が読めるYOLO ソフトウェアとハードウェアの概要を返す。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.collect_system_info()
OS、Python 、RAM、CPU、CUDAなどの関連システム情報を収集し、印刷する。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.check_amp(model)
この関数は、YOLOv8 モデルのPyTorch 自動混合精度(AMP)機能をチェックする。チェックが チェックが失敗した場合、NaNロスまたはゼロMAP結果を引き起こす可能性のあるAMPの異常がシステム上に存在することを意味する。 はトレーニング中に無効になる。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
model |
Module
|
YOLOv8 モデルのインスタンス。 |
必須 |
例
リターンズ
タイプ | 説明 |
---|---|
bool
|
AMP 機能がYOLOv8 モデルで正しく動作する場合は True を、そうでない場合は False を返します。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.git_describe(path=ROOT)
人間が読める git の説明、つまり v5.0-5-g3e25f1e https://git-scm.com/docs/git-describe を返します。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.print_args(args=None, show_file=True, show_func=False)
関数の引数を表示します (オプションの args dict)。
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_device_count()
環境で利用可能なNVIDIA GPUの数を取得します。
リターンズ
タイプ | 説明 |
---|---|
int
|
利用可能なNVIDIA GPUの数。 |
ソースコード ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_is_available()
CUDAが利用可能な環境かどうかを確認する。
リターンズ
タイプ | 説明 |
---|---|
bool
|
1つ以上のNVIDIA GPUが利用可能であればTrue、そうでなければFalse。 |