Docstrings arguments cleanup (#3229)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-06-17 16:17:07 +02:00
committed by GitHub
parent 62916b3b0a
commit bd0f7ecf6f
93 changed files with 1104 additions and 1102 deletions

View File

@ -3,167 +3,167 @@ description: Uncover utility functions in Ultralytics YOLO. Handle YAML, threadi
keywords: Ultralytics, YOLO, utils, SimpleClass, IterableSimpleNamespace, EmojiFilter, TryExcept, plt_settings, set_logging, emojis, yaml_save, yaml_load, yaml_print, is_colab, is_kaggle, is_jupyter, is_docker, is_online, is_pip_package, is_dir_writeable, is_pytest_running, is_github_actions_ci, is_git_dir, get_git_dir, get_git_origin_url, get_git_branch, get_default_args, get_user_config_dir, colorstr, threaded, set_sentry, get_settings, set_settings, deprecation_warn, clean_url, url2file
---
# SimpleClass
## SimpleClass
---
:::ultralytics.yolo.utils.SimpleClass
### ::: ultralytics.yolo.utils.SimpleClass
<br><br>
# IterableSimpleNamespace
## IterableSimpleNamespace
---
:::ultralytics.yolo.utils.IterableSimpleNamespace
### ::: ultralytics.yolo.utils.IterableSimpleNamespace
<br><br>
# EmojiFilter
## EmojiFilter
---
:::ultralytics.yolo.utils.EmojiFilter
### ::: ultralytics.yolo.utils.EmojiFilter
<br><br>
# TryExcept
## TryExcept
---
:::ultralytics.yolo.utils.TryExcept
### ::: ultralytics.yolo.utils.TryExcept
<br><br>
# plt_settings
## plt_settings
---
:::ultralytics.yolo.utils.plt_settings
### ::: ultralytics.yolo.utils.plt_settings
<br><br>
# set_logging
## set_logging
---
:::ultralytics.yolo.utils.set_logging
### ::: ultralytics.yolo.utils.set_logging
<br><br>
# emojis
## emojis
---
:::ultralytics.yolo.utils.emojis
### ::: ultralytics.yolo.utils.emojis
<br><br>
# yaml_save
## yaml_save
---
:::ultralytics.yolo.utils.yaml_save
### ::: ultralytics.yolo.utils.yaml_save
<br><br>
# yaml_load
## yaml_load
---
:::ultralytics.yolo.utils.yaml_load
### ::: ultralytics.yolo.utils.yaml_load
<br><br>
# yaml_print
## yaml_print
---
:::ultralytics.yolo.utils.yaml_print
### ::: ultralytics.yolo.utils.yaml_print
<br><br>
# is_colab
## is_colab
---
:::ultralytics.yolo.utils.is_colab
### ::: ultralytics.yolo.utils.is_colab
<br><br>
# is_kaggle
## is_kaggle
---
:::ultralytics.yolo.utils.is_kaggle
### ::: ultralytics.yolo.utils.is_kaggle
<br><br>
# is_jupyter
## is_jupyter
---
:::ultralytics.yolo.utils.is_jupyter
### ::: ultralytics.yolo.utils.is_jupyter
<br><br>
# is_docker
## is_docker
---
:::ultralytics.yolo.utils.is_docker
### ::: ultralytics.yolo.utils.is_docker
<br><br>
# is_online
## is_online
---
:::ultralytics.yolo.utils.is_online
### ::: ultralytics.yolo.utils.is_online
<br><br>
# is_pip_package
## is_pip_package
---
:::ultralytics.yolo.utils.is_pip_package
### ::: ultralytics.yolo.utils.is_pip_package
<br><br>
# is_dir_writeable
## is_dir_writeable
---
:::ultralytics.yolo.utils.is_dir_writeable
### ::: ultralytics.yolo.utils.is_dir_writeable
<br><br>
# is_pytest_running
## is_pytest_running
---
:::ultralytics.yolo.utils.is_pytest_running
### ::: ultralytics.yolo.utils.is_pytest_running
<br><br>
# is_github_actions_ci
## is_github_actions_ci
---
:::ultralytics.yolo.utils.is_github_actions_ci
### ::: ultralytics.yolo.utils.is_github_actions_ci
<br><br>
# is_git_dir
## is_git_dir
---
:::ultralytics.yolo.utils.is_git_dir
### ::: ultralytics.yolo.utils.is_git_dir
<br><br>
# get_git_dir
## get_git_dir
---
:::ultralytics.yolo.utils.get_git_dir
### ::: ultralytics.yolo.utils.get_git_dir
<br><br>
# get_git_origin_url
## get_git_origin_url
---
:::ultralytics.yolo.utils.get_git_origin_url
### ::: ultralytics.yolo.utils.get_git_origin_url
<br><br>
# get_git_branch
## get_git_branch
---
:::ultralytics.yolo.utils.get_git_branch
### ::: ultralytics.yolo.utils.get_git_branch
<br><br>
# get_default_args
## get_default_args
---
:::ultralytics.yolo.utils.get_default_args
### ::: ultralytics.yolo.utils.get_default_args
<br><br>
# get_user_config_dir
## get_user_config_dir
---
:::ultralytics.yolo.utils.get_user_config_dir
### ::: ultralytics.yolo.utils.get_user_config_dir
<br><br>
# colorstr
## colorstr
---
:::ultralytics.yolo.utils.colorstr
### ::: ultralytics.yolo.utils.colorstr
<br><br>
# threaded
## threaded
---
:::ultralytics.yolo.utils.threaded
### ::: ultralytics.yolo.utils.threaded
<br><br>
# set_sentry
## set_sentry
---
:::ultralytics.yolo.utils.set_sentry
### ::: ultralytics.yolo.utils.set_sentry
<br><br>
# get_settings
## get_settings
---
:::ultralytics.yolo.utils.get_settings
### ::: ultralytics.yolo.utils.get_settings
<br><br>
# set_settings
## set_settings
---
:::ultralytics.yolo.utils.set_settings
### ::: ultralytics.yolo.utils.set_settings
<br><br>
# deprecation_warn
## deprecation_warn
---
:::ultralytics.yolo.utils.deprecation_warn
### ::: ultralytics.yolo.utils.deprecation_warn
<br><br>
# clean_url
## clean_url
---
:::ultralytics.yolo.utils.clean_url
### ::: ultralytics.yolo.utils.clean_url
<br><br>
# url2file
## url2file
---
:::ultralytics.yolo.utils.url2file
### ::: ultralytics.yolo.utils.url2file
<br><br>