diff --git a/docs/en/reference/__init__.md b/docs/en/reference/__init__.md new file mode 100644 index 00000000..a02ccc8d --- /dev/null +++ b/docs/en/reference/__init__.md @@ -0,0 +1,20 @@ +--- +description: Learn how Ultralytics uses lazy imports with __getattr__ to speed up package startup and load model classes like YOLO, NAS, RTDETR, and SAM only when needed. +keywords: Ultralytics, YOLO, lazy import, __getattr__, NAS, RTDETR, SAM, FastSAM, YOLOWorld, performance, startup time, optimization +--- + +# Reference for `ultralytics/__init__.py` + +!!! note + + This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/__init__.py) 🛠️. Thank you 🙏! + +
+ +## ::: ultralytics.__getattr__ + +



+ +## ::: ultralytics.__dir__ + +

diff --git a/mkdocs.yml b/mkdocs.yml index 77a6aa0f..ae13ed5b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -531,6 +531,7 @@ nav: - hub/api/index.md - Reference: + - __init__: reference/__init__.md - cfg: - __init__: reference/cfg/__init__.md - data: diff --git a/ultralytics/__init__.py b/ultralytics/__init__.py index 4c68b256..bd2364b6 100644 --- a/ultralytics/__init__.py +++ b/ultralytics/__init__.py @@ -1,30 +1,43 @@ # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license -__version__ = "8.3.198" +__version__ = "8.3.199" +import importlib import os # Set ENV variables (place before imports) if not os.environ.get("OMP_NUM_THREADS"): os.environ["OMP_NUM_THREADS"] = "1" # default for reduced CPU utilization during training -from ultralytics.models import NAS, RTDETR, SAM, YOLO, YOLOE, FastSAM, YOLOWorld from ultralytics.utils import ASSETS, SETTINGS from ultralytics.utils.checks import check_yolo as checks from ultralytics.utils.downloads import download settings = SETTINGS + +MODELS = ("YOLO", "YOLOWorld", "YOLOE", "NAS", "SAM", "FastSAM", "RTDETR") + __all__ = ( "__version__", "ASSETS", - "YOLO", - "YOLOWorld", - "YOLOE", - "NAS", - "SAM", - "FastSAM", - "RTDETR", + *MODELS, "checks", "download", "settings", ) + + +def __getattr__(name: str): + """Lazy-import model classes on first access.""" + if name in MODELS: + return getattr(importlib.import_module("ultralytics.models"), name) + raise AttributeError(f"module {__name__} has no attribute {name}") + + +def __dir__(): + """Extend dir() to include lazily available model names for IDE autocompletion.""" + return sorted(set(globals()) | set(MODELS)) + + +if __name__ == "__main__": + print(__version__)