Ruff format docstring Python code (#15792)

Signed-off-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
This commit is contained in:
Glenn Jocher 2024-08-25 01:08:07 +08:00 committed by GitHub
parent c1882a4327
commit d27664216b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
63 changed files with 370 additions and 374 deletions

View file

@ -62,7 +62,7 @@ def parse_requirements(file_path=ROOT.parent / "requirements.txt", package=""):
```python
from ultralytics.utils.checks import parse_requirements
parse_requirements(package='ultralytics')
parse_requirements(package="ultralytics")
```
"""
@ -197,16 +197,16 @@ def check_version(
Example:
```python
# Check if current version is exactly 22.04
check_version(current='22.04', required='==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_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_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')
check_version(current="21.10", required=">20.04,<22.04")
```
"""
if not current: # if current is '' or None
@ -353,13 +353,13 @@ def check_requirements(requirements=ROOT.parent / "requirements.txt", exclude=()
from ultralytics.utils.checks import check_requirements
# Check a requirements.txt file
check_requirements('path/to/requirements.txt')
check_requirements("path/to/requirements.txt")
# Check a single package
check_requirements('ultralytics>=8.0.0')
check_requirements("ultralytics>=8.0.0")
# Check multiple packages
check_requirements(['numpy', 'ultralytics>=8.0.0'])
check_requirements(["numpy", "ultralytics>=8.0.0"])
```
"""
@ -634,7 +634,7 @@ def check_amp(model):
from ultralytics import YOLO
from ultralytics.utils.checks import check_amp
model = YOLO('yolov8n.pt').model.cuda()
model = YOLO("yolov8n.pt").model.cuda()
check_amp(model)
```