Tài liệu tham khảo cho ultralytics/utils/__init__.py
Ghi
Tệp này có sẵn tại https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/init.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.TQDM
Căn cứ: tqdm
Phong tục Ultralytics Lớp TQDM với các đối số mặc định khác nhau.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
*args |
list
|
Các đối số vị trí được chuyển sang tqdm ban đầu. |
()
|
**kwargs |
any
|
Đối số từ khóa, với mặc định tùy chỉnh được áp dụng. |
{}
|
Mã nguồn trong ultralytics/utils/__init__.py
__init__(*args, **kwargs)
Khởi tạo tùy chỉnh Ultralytics Lớp TQDM với các đối số mặc định khác nhau.
Lưu ý rằng chúng vẫn có thể bị ghi đè khi gọi TQDM.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.SimpleClass
Ultralytics SimpleClass là một lớp cơ sở cung cấp biểu diễn chuỗi, báo cáo lỗi và thuộc tính hữu ích Phương pháp truy cập để gỡ lỗi và sử dụng dễ dàng hơn.
Mã nguồn trong ultralytics/utils/__init__.py
__getattr__(attr)
Thông báo lỗi truy cập thuộc tính tùy chỉnh với thông tin hữu ích.
Mã nguồn trong ultralytics/utils/__init__.py
__repr__()
__str__()
Trả về biểu diễn chuỗi mà con người có thể đọc được của đối tượng.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.IterableSimpleNamespace
Căn cứ: SimpleNamespace
Ultralytics IterableSimpleNamespace là một lớp mở rộng của SimpleNamespace bổ sung chức năng lặp lại và cho phép sử dụng với dict() và cho các vòng lặp.
Mã nguồn trong ultralytics/utils/__init__.py
__getattr__(attr)
Thông báo lỗi truy cập thuộc tính tùy chỉnh với thông tin hữu ích.
Mã nguồn trong ultralytics/utils/__init__.py
__iter__()
__str__()
get(key, default=None)
Trả về giá trị của khóa được chỉ định nếu nó tồn tại; nếu không, hãy trả về giá trị mặc định.
ultralytics.utils.ThreadingLocked
Một lớp trang trí để đảm bảo thực thi an toàn luồng của một hàm hoặc phương thức. Lớp này có thể được sử dụng như một trang trí Để đảm bảo rằng nếu chức năng trang trí được gọi từ nhiều luồng, chỉ một luồng tại một thời điểm sẽ có thể để thực hiện hàm.
Thuộc tính:
Tên | Kiểu | Sự miêu tả |
---|---|---|
lock |
Lock
|
Một đối tượng khóa được sử dụng để quản lý quyền truy cập vào chức năng trang trí. |
Ví dụ
Mã nguồn trong ultralytics/utils/__init__.py
__call__(f)
Chạy thực thi thread-safe của hàm hoặc phương thức.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.TryExcept
Căn cứ: ContextDecorator
Ultralytics Lớp TryExcept . Sử dụng làm trình trang trí @TryExcept() hoặc trình quản lý ngữ cảnh 'với TryExcept():'.
Ví dụ:
Là một người trang trí:
>>> @TryExcept(msg="Error occurred in func", verbose=True)
>>> def func():
>>> # Function logic here
>>> pass
Là người quản lý ngữ cảnh:
Mã nguồn trong ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, value, traceback)
Xác định hành vi khi thoát khỏi khối 'với', in thông báo lỗi nếu cần.
__init__(msg='', verbose=True)
ultralytics.utils.Retry
Căn cứ: ContextDecorator
Thử lại lớp để thực thi hàm với backoff theo cấp số nhân.
Có thể được sử dụng như một trình trang trí hoặc trình quản lý ngữ cảnh để thử lại một chức năng hoặc khối mã trên các ngoại lệ, tối đa số lần được chỉ định với độ trễ tăng theo cấp số nhân giữa các lần thử lại.
Ví dụ:
Ví dụ sử dụng như một người trang trí:
>>> @Retry(times=3, delay=2)
>>> def test_func():
>>> # Replace with function logic that may raise exceptions
>>> return True
Ví dụ sử dụng làm trình quản lý ngữ cảnh:
Mã nguồn trong ultralytics/utils/__init__.py
__call__(func)
Triển khai trang trí cho Thử lại với backoff theo cấp số nhân.
Mã nguồn trong ultralytics/utils/__init__.py
__enter__()
__exit__(exc_type, exc_value, traceback)
Thoát khỏi ngữ cảnh thời gian chạy liên quan đến đối tượng này với backoff theo cấp số nhân.
Mã nguồn trong ultralytics/utils/__init__.py
__init__(times=3, delay=2)
ultralytics.utils.SettingsManager
Căn cứ: dict
Quản lý Ultralytics cài đặt được lưu trữ trong tệp YAML.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
file |
str | Path
|
Đường dẫn đến Ultralytics cài đặt tệp YAML. Mặc định là USER_CONFIG_DIR / 'settings.yaml'. |
SETTINGS_YAML
|
version |
str
|
Phiên bản cài đặt. Trong trường hợp phiên bản cục bộ không khớp, cài đặt mặc định mới sẽ được lưu. |
'0.0.4'
|
Mã nguồn trong ultralytics/utils/__init__.py
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 |
|
__init__(file=SETTINGS_YAML, version='0.0.4')
Khởi tạo SettingsManager với các cài đặt mặc định, tải và xác thực các cài đặt hiện tại từ YAML tệp.
Mã nguồn trong ultralytics/utils/__init__.py
load()
reset()
save()
ultralytics.utils.plt_settings(rcparams=None, backend='Agg')
Trang trí để tạm thời thiết lập các tham số rc và phụ trợ cho chức năng vẽ.
Ví dụ
decorator: @plt_settings({"font.size": 12}) context manager: with plt_settings({"font.size": 12}):
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
rcparams |
dict
|
Từ điển các tham số rc để thiết lập. |
None
|
backend |
str
|
Tên của backend để sử dụng. Mặc định là 'Agg'. |
'Agg'
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
Callable
|
Chức năng trang trí với các thông số rc được thiết lập tạm thời và phụ trợ. Trang trí này có thể là Áp dụng cho bất kỳ chức năng nào cần có các tham số Matplotlib RC cụ thể và phụ trợ để thực thi. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.set_logging(name='LOGGING_NAME', verbose=True)
Thiết lập ghi nhật ký cho tên đã cho với hỗ trợ mã hóa UTF-8, đảm bảo khả năng tương thích giữa các tên khác nhau Môi trường.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.emojis(string='')
ultralytics.utils.yaml_save(file='data.yaml', data=None, header='')
Lưu dữ liệu YAML vào một tệp.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
file |
str
|
Tên tập tin. Mặc định là 'data.yaml'. |
'data.yaml'
|
data |
dict
|
Dữ liệu cần lưu ở định dạng YAML. |
None
|
header |
str
|
Tiêu đề YAML để thêm. |
''
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
None
|
Dữ liệu được lưu vào tệp được chỉ định. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.yaml_load(file='data.yaml', append_filename=False)
Tải dữ liệu YAML từ một tệp.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
file |
str
|
Tên tập tin. Mặc định là 'data.yaml'. |
'data.yaml'
|
append_filename |
bool
|
Thêm tên tệp YAML vào từ điển YAML. Mặc định là False. |
False
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
dict
|
Dữ liệu YAML và tên tệp. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.yaml_print(yaml_file)
Pretty in một tập tin YAML hoặc một từ điển định dạng YAML.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
yaml_file |
Union[str, Path, dict]
|
Đường dẫn tệp của tệp YAML hoặc từ điển định dạng YAML. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
None
|
(Không có) |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.read_device_model()
Đọc thông tin kiểu thiết bị từ hệ thống và lưu vào bộ nhớ cache để truy cập nhanh. Được sử dụng bởi is_jetson() và is_raspberrypi().
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str
|
Mô hình hóa nội dung tệp nếu đọc thành công hoặc chuỗi trống khác. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_ubuntu()
Kiểm tra xem hệ điều hành có phải là Ubuntu không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu OS là Ubuntu, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_colab()
Kiểm tra xem tập lệnh hiện tại có đang chạy bên trong sổ ghi chép Google Colab hay không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chạy bên trong sổ ghi chép Colab, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_kaggle()
Kiểm tra xem tập lệnh hiện tại có đang chạy bên trong hạt nhân Kaggle hay không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chạy bên trong hạt nhân Kaggle, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_jupyter()
Kiểm tra xem tập lệnh hiện tại có đang chạy bên trong Jupyter Notebook hay không. Được xác minh trên Colab, Jupyterlab, Kaggle, Paperspace.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chạy bên trong Jupyter Notebook, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_docker()
Xác định xem tập lệnh có đang chạy bên trong bộ chứa Docker hay không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu script đang chạy bên trong Docker container, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_raspberrypi()
Xác định xem Python môi trường đang chạy trên Raspberry Pi bằng cách kiểm tra thông tin mô hình thiết bị.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chạy trên Raspberry Pi, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_jetson()
Xác định xem Python môi trường đang chạy trên thiết bị Jetson Nano hoặc Jetson Orin bằng cách kiểm tra kiểu thiết bị thông tin.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu chạy trên Jetson Nano hoặc Jetson Orin, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_online()
Kiểm tra kết nối internet bằng cách cố gắng kết nối với một máy chủ trực tuyến đã biết.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu kết nối thành công, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_pip_package(filepath=__name__)
Xác định xem tệp tại đường dẫn tệp đã cho có phải là một phần của gói pip hay không.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
filepath |
str
|
Đường dẫn tệp để kiểm tra. |
__name__
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu tệp là một phần của gói pip, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_dir_writeable(dir_path)
Kiểm tra xem một thư mục có thể ghi được không.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
dir_path |
str | Path
|
Đường dẫn đến thư mục. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu thư mục có thể ghi được, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_pytest_running()
Xác định xem pytest hiện có đang chạy hay không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu pytest đang chạy, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_github_action_running()
Xác định xem môi trường hiện tại có phải là trình chạy GitHub Actions hay không.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu môi trường hiện tại là GitHub Actions runner, False nếu không. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_git_dir()
Xác định xem tệp hiện tại có phải là một phần của kho lưu trữ git hay không và nếu có, trả về thư mục gốc của kho lưu trữ. Nếu tệp hiện tại không phải là một phần của kho lưu trữ git, trả về Không có.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
Path | None
|
Thư mục gốc Git nếu tìm thấy hoặc Không có nếu không tìm thấy. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.is_git_dir()
Xác định xem tệp hiện tại có phải là một phần của kho lưu trữ git hay không. Nếu tệp hiện tại không phải là một phần của git kho lưu trữ, trả về Không có.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
bool
|
True nếu tệp hiện tại là một phần của kho lưu trữ git. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_git_origin_url()
Truy xuất URL gốc của kho lưu trữ git.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str | None
|
URL gốc của git repository hoặc None nếu không phải là thư mục git. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_git_branch()
Trả về tên nhánh git hiện tại. Nếu không có trong kho lưu trữ git, trả về Không có.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str | None
|
Tên nhánh git hiện tại hoặc Không có nếu không phải là thư mục git. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_default_args(func)
Trả về từ điển các đối số mặc định cho một hàm.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
func |
callable
|
Chức năng kiểm tra. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
dict
|
Từ điển trong đó mỗi khóa là một tên tham số và mỗi giá trị là giá trị mặc định của tham số đó. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_ubuntu_version()
Truy xuất phiên bản Ubuntu nếu HĐH là Ubuntu.
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str
|
Phiên bản Ubuntu hoặc Không có nếu không phải là hệ điều hành Ubuntu. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.get_user_config_dir(sub_dir='Ultralytics')
Trả về thư mục cấu hình thích hợp dựa trên hệ điều hành môi trường.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
sub_dir |
str
|
Tên của thư mục con để tạo. |
'Ultralytics'
|
Trở lại:
Kiểu | Sự miêu tả |
---|---|
Path
|
Đường dẫn đến thư mục cấu hình người dùng. |
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.colorstr(*input)
Tô màu một chuỗi dựa trên các đối số màu và kiểu được cung cấp. Sử dụng mã thoát ANSI. Xem https://en.wikipedia.org/wiki/ANSI_escape_code để biết thêm chi tiết.
Hàm này có thể được gọi theo hai cách:
- colorstr('màu', 'kiểu', 'chuỗi của bạn')
- colorstr ('chuỗi của bạn')
Ở dạng thứ hai, 'xanh dương' và 'đậm' sẽ được áp dụng theo mặc định.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
*input |
str
|
Một chuỗi các chuỗi trong đó chuỗi n-1 đầu tiên là các đối số màu và kiểu, và chuỗi cuối cùng là chuỗi được tô màu. |
()
|
Màu sắc và kiểu dáng được hỗ trợ
Màu cơ bản: 'đen', 'đỏ', 'xanh lá cây', 'vàng', 'xanh dương', 'đỏ tươi', 'lục lam', 'trắng' Màu sắc tươi sáng: 'bright_black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white' Misc: 'kết thúc', 'đậm', 'gạch chân'
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str
|
Chuỗi đầu vào được bọc bằng mã thoát ANSI cho màu sắc và kiểu dáng được chỉ định. |
Ví dụ:
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.remove_colorstr(input_string)
Loại bỏ mã thoát ANSI khỏi một chuỗi, bỏ tô màu nó một cách hiệu quả.
Thông số:
Tên | Kiểu | Sự miêu tả | Mặc định |
---|---|---|---|
input_string |
str
|
Chuỗi để loại bỏ màu sắc và kiểu dáng. |
bắt buộc |
Trở lại:
Kiểu | Sự miêu tả |
---|---|
str
|
Một chuỗi mới với tất cả các mã thoát ANSI bị xóa. |
Ví dụ:
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.threaded(func)
Đa luồng một hàm đích theo mặc định và trả về kết quả chuỗi hoặc hàm.
Sử dụng như @threaded trang trí. Hàm chạy trong một luồng riêng biệt trừ khi 'threaded = False' được thông qua.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.set_sentry()
Khởi tạo Sentry SDK để theo dõi và báo cáo lỗi. Chỉ được sử dụng nếu gói sentry_sdk được cài đặt và sync=True trong cài đặt. Chạy 'yolo cài đặt 'để xem và cập nhật cài đặt tệp YAML.
Các điều kiện cần thiết để gửi lỗi (TẤT CẢ các điều kiện phải được đáp ứng hoặc sẽ không có lỗi nào được báo cáo): - sentry_sdk gói được cài đặt - sync=True trong YOLO Cài đặt - pytest không chạy - chạy trong cài đặt gói pip - chạy trong một thư mục không phải git - Chạy với thứ hạng -1 hoặc 0 - Môi trường trực tuyến - CLI được sử dụng để chạy gói (kiểm tra với 'yolo' như tên của chính CLI chỉ huy)
Chức năng này cũng cấu hình Sentry SDK để bỏ qua KeyboardInterrupt và FileNotFoundError ngoại lệ và để loại trừ các sự kiện có 'hết bộ nhớ' trong thông báo ngoại lệ.
Ngoài ra, hàm đặt thẻ tùy chỉnh và thông tin người dùng cho các sự kiện Sentry.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.deprecation_warn(arg, new_arg, version=None)
Đưa ra cảnh báo không dùng nữa khi sử dụng đối số không dùng nữa, đề xuất đối số cập nhật.
Mã nguồn trong ultralytics/utils/__init__.py
ultralytics.utils.clean_url(url)
Dải auth từ URL, tức là https://url.com/file.txt?auth -> https://url.com/file.txt.