Referentie voor ultralytics/utils/checks.py
Opmerking
Dit bestand is beschikbaar op https://github.com/ultralytics/ ultralytics/blob/main/ ultralytics/utils/checks .py. Als je een probleem ziet, help het dan oplossen door een Pull Request 🛠️ bij te dragen. Bedankt 🙏!
ultralytics.utils.checks.parse_requirements(file_path=ROOT.parent / 'requirements.txt', package='')
Parseer een requirements.txt bestand, waarbij regels die beginnen met '#' en tekst na '#' genegeerd worden.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
file_path |
Path
|
Pad naar het bestand requirements.txt. |
parent / 'requirements.txt'
|
package |
str
|
Python pakket te gebruiken in plaats van requirements.txt bestand, dus package='ultralytics'. |
''
|
Retourneert:
Type | Beschrijving |
---|---|
List[Dict[str, str]]
|
Lijst van geparseerde vereisten als woordenboeken met |
Voorbeeld
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.parse_version(version='0.0.0')
Converteer een versie-tekenreeks naar een tupel van gehele getallen, waarbij alle extra niet-numerieke tekenreeksen die aan de versie zijn gekoppeld worden genegeerd. Deze functie vervangt de verouderde 'pkg_resources.parse_version(v)'.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
version |
str
|
Versie string, bijvoorbeeld '2.0.1+cpu'. |
'0.0.0'
|
Retourneert:
Type | Beschrijving |
---|---|
tuple
|
Tupel van gehele getallen die het numerieke deel van de versie en de extra tekenreeks vertegenwoordigen, dus (2, 0, 1) |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.is_ascii(s)
Controleer of een tekenreeks alleen uit ASCII-tekens bestaat.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
s |
str
|
String die moet worden gecontroleerd. |
vereist |
Retourneert:
Type | Beschrijving |
---|---|
bool
|
True als de string alleen uit ASCII-tekens bestaat, anders False. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_imgsz(imgsz, stride=32, min_dim=1, max_dim=2, floor=0)
Controleer of de afbeeldingsgrootte een veelvoud is van de gegeven stride in elke dimensie. Als de afbeeldingsgrootte geen veelvoud is van de stride is, wordt deze bijgewerkt naar het dichtstbijzijnde veelvoud van de stride dat groter is dan of gelijk is aan de opgegeven vloerwaarde.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
imgsz |
int | cList[int]
|
Afbeeldingsformaat. |
vereist |
stride |
int
|
Stapwaarde. |
32
|
min_dim |
int
|
Minimaal aantal afmetingen. |
1
|
max_dim |
int
|
Maximaal aantal afmetingen. |
2
|
floor |
int
|
Minimaal toegestane waarde voor afbeeldingsgrootte. |
0
|
Retourneert:
Type | Beschrijving |
---|---|
List[int]
|
Afbeeldingsgrootte bijgewerkt. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_version(current='0.0.0', required='0.0.0', name='version', hard=False, verbose=False, msg='')
Controleer de huidige versie ten opzichte van de vereiste versie of het vereiste bereik.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
current |
str
|
Huidige versie of pakketnaam om versie van te krijgen. |
'0.0.0'
|
required |
str
|
Vereiste versie of bereik (in pip-stijl formaat). |
'0.0.0'
|
name |
str
|
Naam die in het waarschuwingsbericht moet worden gebruikt. |
'version'
|
hard |
bool
|
Als dit waar is, wordt een AssertionError weergegeven als niet aan de voorwaarde wordt voldaan. |
False
|
verbose |
bool
|
Als dit waar is, wordt er een waarschuwingsbericht afgedrukt als niet aan de voorwaarde wordt voldaan. |
False
|
msg |
str
|
Extra bericht om weer te geven bij verbose. |
''
|
Retourneert:
Type | Beschrijving |
---|---|
bool
|
True als aan de voorwaarde is voldaan, anders False. |
Voorbeeld
# 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')
Broncode in 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')
Geeft de laatste versie van een PyPI pakket zonder het te downloaden of te installeren.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
package_name |
str
|
De naam van het pakket om de laatste versie voor te zoeken. |
'ultralytics'
|
Retourneert:
Type | Beschrijving |
---|---|
str
|
De nieuwste versie van het pakket. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_pip_update_available()
Controleert of er een nieuwe versie van het ultralytics pakket beschikbaar is op PyPI.
Retourneert:
Type | Beschrijving |
---|---|
bool
|
True als er een update beschikbaar is, anders False. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_font(font='Arial.ttf')
Zoek het lettertype lokaal of download het naar de configuratiemap van de gebruiker als deze nog niet bestaat.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
font |
str
|
Pad of naam van lettertype. |
'Arial.ttf'
|
Retourneert:
Naam | Type | Beschrijving |
---|---|---|
file |
Path
|
Lettertype bestandspad opgelost. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_python(minimum='3.8.0')
Controleer de huidige versie python ten opzichte van de vereiste minimumversie.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
minimum |
str
|
Vereiste minimumversie van python. |
'3.8.0'
|
Retourneert:
Type | Beschrijving |
---|---|
bool
|
Of de geïnstalleerde versie Python voldoet aan de minimale beperkingen. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_requirements(requirements=ROOT.parent / 'requirements.txt', exclude=(), install=True, cmds='')
Controleer of de geïnstalleerde afhankelijkheden voldoen aan YOLOv8 en probeer indien nodig automatisch bij te werken.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
requirements |
Union[Path, str, List[str]]
|
Pad naar een requirements.txt bestand, een enkele pakketvereiste als een string, of een lijst met pakketvereisten als strings. |
parent / 'requirements.txt'
|
exclude |
Tuple[str]
|
Tupel van pakketnamen om uit te sluiten van controle. |
()
|
install |
bool
|
Als dit waar is, probeer dan pakketten die niet aan de eisen voldoen automatisch bij te werken. |
True
|
cmds |
str
|
Extra commando's om door te geven aan het pip install commando bij het automatisch updaten. |
''
|
Voorbeeld
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_torchvision()
Controleert de geïnstalleerde versies van PyTorch en Torchvision om er zeker van te zijn dat ze compatibel zijn.
Deze functie controleert de geïnstalleerde versies van PyTorch en Torchvision en waarschuwt als ze incompatibel zijn volgens volgens de meegeleverde compatibiliteitstabel gebaseerd op: https://github.com/pytorch/vision#installatie.
De compatibiliteitstabel is een woordenboek waarin de sleutels PyTorch versies zijn en de waarden lijsten van compatibele Torchvision-versies zijn.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_suffix(file='yolov8n.pt', suffix='.pt', msg='')
Controleer bestand(en) op acceptabel achtervoegsel.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolov5u_filename(file, verbose=True)
Oude YOLOv5 bestandsnamen vervangen door bijgewerkte YOLOv5u bestandsnamen.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_model_file_from_stem(model='yolov8n')
Geeft een modelbestandsnaam terug van een geldige modelstam.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_file(file, suffix='', download=True, hard=True)
Zoek/download bestand (indien nodig) en retourneer pad.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_yaml(file, suffix=('.yaml', '.yml'), hard=True)
YAML-bestand zoeken/downloaden (indien nodig) en pad retourneren, achtervoegsel controleren.
ultralytics.utils.checks.check_is_path_safe(basedir, path)
Controleer of het opgeloste pad zich onder de bedoelde map bevindt om path traversal te voorkomen.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
basedir |
Path | str
|
De bedoelde map. |
vereist |
path |
Path | str
|
Het pad om te controleren. |
vereist |
Retourneert:
Type | Beschrijving |
---|---|
bool
|
True als het pad veilig is, anders False. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_imshow(warn=False)
Controleer of de omgeving beeldschermen ondersteunt.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_yolo(verbose=True, device='')
Stuur een door mensen leesbare samenvatting van YOLO software en hardware terug.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.collect_system_info()
Relevante systeeminformatie verzamelen en afdrukken, waaronder OS, Python, RAM, CPU en CUDA.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.check_amp(model)
Deze functie controleert de PyTorch Automatische Gemengde Precisie (AMP) functionaliteit van een YOLOv8 model. Als de controles mislukken, betekent dit dat er afwijkingen zijn met AMP op het systeem die NaN-verliezen of nul-MAP resultaten kunnen veroorzaken. uitgeschakeld worden tijdens de training.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
model |
Module
|
Een instantie van een YOLOv8 model. |
vereist |
Voorbeeld
Retourneert:
Type | Beschrijving |
---|---|
bool
|
Geeft True terug als de AMP-functionaliteit correct werkt met YOLOv8 model, anders False. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.git_describe(path=ROOT)
Geeft een menselijk leesbare git beschrijving, bijvoorbeeld v5.0-5-g3e25f1e https://git-scm.com/docs/git-describe.
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.print_args(args=None, show_file=True, show_func=False)
Functieargumenten afdrukken (optioneel args dict).
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_device_count()
Geef het aantal NVIDIA GPU's op dat beschikbaar is in de omgeving.
Retourneert:
Type | Beschrijving |
---|---|
int
|
Het aantal beschikbare NVIDIA GPU's. |
Broncode in ultralytics/utils/checks.py
ultralytics.utils.checks.cuda_is_available()
Controleer of CUDA beschikbaar is in de omgeving.
Retourneert:
Type | Beschrijving |
---|---|
bool
|
True als een of meer NVIDIA GPU's beschikbaar zijn, anders False. |