Tài liệu tham khảo cho ultralytics/utils/checks.py
Ghi
Tệp này có sẵn tại https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py. Nếu bạn phát hiện ra một vấn đề, vui lòng giúp khắc phục nó bằng cách đóng góp Yêu cầu 🛠️ kéo. Cảm ơn bạn 🙏 !
ultralytics.utils.checks.parse_requirements(file_path=ROOT.parent / 'requirements.txt', package='')
Phân tích cú pháp tệp requirements.txt, bỏ qua các dòng bắt đầu bằng '#' và bất kỳ văn bản nào sau '#'.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
file_path |
Path
|
Đường dẫn đến tệp requirements.txt. |
parent / 'requirements.txt'
|
package |
str
|
Python gói để sử dụng thay vì requirements.txt tệp, tức là gói = 'ultralytics'. |
''
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
List[Dict[str, str]]
|
Danh sách các yêu cầu phân tích cú pháp dưới dạng từ điển với |
Ví dụ
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.parse_version(version='0.0.0')
Chuyển đổi một chuỗi phiên bản thành một bộ số nguyên, bỏ qua bất kỳ chuỗi không phải số bổ sung nào được đính kèm với phiên bản. Này Hàm thay thế 'pkg_resources.parse_version(v)' không dùng nữa.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
version |
str
|
Chuỗi phiên bản, tức là '2.0.1+cpu' |
'0.0.0'
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
tuple
|
Bộ số nguyên đại diện cho phần số của phiên bản và chuỗi phụ, tức là (2, 0, 1) |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.is_ascii(s)
Kiểm tra xem một chuỗi có chỉ bao gồm các ký tự ASCII hay không.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
s |
str
|
Chuỗi cần kiểm tra. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chuỗi chỉ bao gồm các ký tự ASCII, False nếu không. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_imgsz(imgsz, stride=32, min_dim=1, max_dim=2, floor=0)
Xác minh kích thước hình ảnh là bội số của sải chân đã cho trong mỗi chiều. Nếu kích thước hình ảnh không phải là bội số của Sải bước, cập nhật nó thành bội số gần nhất của sải chân lớn hơn hoặc bằng giá trị sàn đã cho.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
imgsz |
int | cList[int]
|
Kích thước hình ảnh. |
bắt buộc |
stride |
int
|
Giá trị sải chân. |
32
|
min_dim |
int
|
Số lượng kích thước tối thiểu. |
1
|
max_dim |
int
|
Số lượng kích thước tối đa. |
2
|
floor |
int
|
Giá trị tối thiểu được phép cho kích thước hình ảnh. |
0
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
List[int]
|
Cập nhật kích thước hình ảnh. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_version(current='0.0.0', required='0.0.0', name='version', hard=False, verbose=False, msg='')
Kiểm tra phiên bản hiện tại so với phiên bản hoặc phạm vi yêu cầu.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
current |
str
|
Phiên bản hiện tại hoặc tên gói để lấy phiên bản. |
'0.0.0'
|
required |
str
|
Phiên bản hoặc phạm vi bắt buộc (ở định dạng kiểu pip). |
'0.0.0'
|
name |
str
|
Tên sẽ được sử dụng trong thông báo cảnh báo. |
'version'
|
hard |
bool
|
Nếu True, hãy đưa ra AssertionError nếu yêu cầu không được đáp ứng. |
False
|
verbose |
bool
|
Nếu True, in thông báo cảnh báo nếu yêu cầu không được đáp ứng. |
False
|
msg |
str
|
Thông báo bổ sung để hiển thị nếu dài dòng. |
''
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu yêu cầu được đáp ứng, False nếu không. |
Ví dụ
# 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')
Mã nguồn trong 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')
Trả về phiên bản mới nhất của gói PyPI mà không cần tải xuống hoặc cài đặt nó.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
package_name |
str
|
Tên của gói để tìm phiên bản mới nhất cho. |
'ultralytics'
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str
|
Phiên bản mới nhất của gói. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_pip_update_available()
Kiểm tra xem phiên bản mới của ultralytics gói có sẵn trên PyPI.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu có bản cập nhật, False nếu không. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_font(font='Arial.ttf')
Tìm phông chữ cục bộ hoặc tải xuống thư mục cấu hình của người dùng nếu nó chưa tồn tại.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
font |
str
|
Đường dẫn hoặc tên phông chữ. |
'Arial.ttf'
|
Trở lại:
Tên | Kiểu | Sự miêu tả |
---|---|---|
file |
Path
|
Đường dẫn tệp phông chữ đã giải quyết. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_python(minimum='3.8.0')
Kiểm tra hiện tại python phiên bản so với phiên bản tối thiểu bắt buộc.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
minimum |
str
|
Phiên bản tối thiểu bắt buộc của python. |
'3.8.0'
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
Cho dù cài đặt Python Phiên bản đáp ứng các ràng buộc tối thiểu. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_requirements(requirements=ROOT.parent / 'requirements.txt', exclude=(), install=True, cmds='')
Kiểm tra xem các phần phụ thuộc đã cài đặt có đáp ứng không YOLOv8 yêu cầu và cố gắng tự động cập nhật nếu cần.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
requirements |
Union[Path, str, List[str]]
|
Đường dẫn đến tệp requirements.txt, một yêu cầu gói duy nhất dưới dạng chuỗi hoặc danh sách các yêu cầu gói dưới dạng chuỗi. |
parent / 'requirements.txt'
|
exclude |
Tuple[str]
|
Tuple của tên gói để loại trừ khỏi kiểm tra. |
()
|
install |
bool
|
Nếu True, hãy thử tự động cập nhật các gói không đáp ứng yêu cầu. |
True
|
cmds |
str
|
Các lệnh bổ sung để chuyển đến lệnh cài đặt pip khi tự động cập nhật. |
''
|
Ví dụ
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_torchvision()
Kiểm tra các phiên bản đã cài đặt của PyTorch và Torchvision để đảm bảo chúng tương thích.
Chức năng này kiểm tra các phiên bản đã cài đặt của PyTorch và Torchvision, và cảnh báo nếu chúng không tương thích theo vào bảng tương thích được cung cấp dựa trên: https://github.com/pytorch/vision#cài đặt.
Bảng tương thích là một từ điển chứa các phím PyTorch Phiên bản và giá trị là danh sách tương thích Phiên bản Torchvision.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_suffix(file='yolov8n.pt', suffix='.pt', msg='')
Kiểm tra (các) tệp để biết hậu tố được chấp nhận.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolov5u_filename(file, verbose=True)
Thay thế di sản YOLOv5 tên tệp với tên tệp YOLOv5u được cập nhật.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_model_file_from_stem(model='yolov8n')
Trả về tên tệp mô hình từ gốc mô hình hợp lệ.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_file(file, suffix='', download=True, hard=True)
Tìm kiếm / tải xuống tệp (nếu cần) và đường dẫn trả về.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_yaml(file, suffix=('.yaml', '.yml'), hard=True)
Tìm kiếm / tải xuống tệp YAML (nếu cần) và đường dẫn trả về, kiểm tra hậu tố.
ultralytics.utils.checks.check_is_path_safe(basedir, path)
Kiểm tra xem đường dẫn đã giải quyết có nằm trong thư mục dự định để ngăn đường dẫn đi qua hay không.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
basedir |
Path | str
|
Thư mục dự định. |
bắt buộc |
path |
Path | str
|
Đường dẫn để kiểm tra. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu con đường an toàn, False khác. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_imshow(warn=False)
Kiểm tra xem môi trường có hỗ trợ hiển thị hình ảnh hay không.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolo(verbose=True, device='')
Trả về một con người có thể đọc được YOLO Tóm tắt phần mềm và phần cứng.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.collect_system_info()
Thu thập và in thông tin hệ thống có liên quan bao gồm hệ điều hành, Python, RAM, CPU và CUDA.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.check_amp(model)
Chức năng này kiểm tra PyTorch Chức năng Độ chính xác hỗn hợp tự động (AMP) của một YOLOv8 mẫu. Nếu kiểm tra thất bại, điều đó có nghĩa là có sự bất thường với AMP trên hệ thống có thể gây ra tổn thất NaN hoặc kết quả zero-mAP, vì vậy AMP sẽ bị vô hiệu hóa trong quá trình đào tạo.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
model |
Module
|
Một YOLOv8 phiên bản mô hình. |
bắt buộc |
Ví dụ
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
Trả về True nếu hàm AMP hoạt động đúng với YOLOv8 mô hình, khác Sai. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.git_describe(path=ROOT)
Trả về mô tả git mà con người có thể đọc được, tức là v5.0-5-g3e25f1e https://git-scm.com/docs/git-describe.
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.print_args(args=None, show_file=True, show_func=False)
In các đối số hàm (lệnh args tùy chọn).
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_device_count()
Nhận số lượng GPU NVIDIA có sẵn trong môi trường.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
int
|
Số lượng GPU NVIDIA có sẵn. |
Mã nguồn trong ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_is_available()
Kiểm tra xem CUDA có sẵn trong môi trường không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu một hoặc nhiều GPU NVIDIA có sẵn, False nếu không. |