diff --git a/docs/assets.md b/docs/assets.md index 4fded6e7..13e3cbfb 100644 --- a/docs/assets.md +++ b/docs/assets.md @@ -3,7 +3,7 @@ that you can use in your demos. ## install extra -To install the Supervision assets utility, you can use pip. This utility is available +To install the Supervision assets utility, you can use `pip`. This utility is available as an extra within the Supervision package. !!! example "pip install" diff --git a/pyproject.toml b/pyproject.toml index b0add150..09e66f7e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "supervision" -version = "0.17.0rc1" +version = "0.17.0rc2" description = "A set of easy-to-use utils that will come in handy in any Computer Vision project" authors = ["Piotr Skalski "] maintainers = ["Piotr Skalski "] diff --git a/supervision/assets/__init__.py b/supervision/assets/__init__.py index 18cc0810..3b76c5ab 100644 --- a/supervision/assets/__init__.py +++ b/supervision/assets/__init__.py @@ -1,2 +1,2 @@ -from .downloader import download_assets -from .list import VideoAssets +from supervision.assets.downloader import download_assets +from supervision.assets.list import VideoAssets diff --git a/supervision/assets/downloader.py b/supervision/assets/downloader.py index 04f1b4b2..9b12264a 100644 --- a/supervision/assets/downloader.py +++ b/supervision/assets/downloader.py @@ -4,8 +4,7 @@ from pathlib import Path from shutil import copyfileobj from typing import Union -from supervision.assets import VideoAssets -from supervision.assets.list import VIDEO_ASSETS +from supervision.assets.list import VIDEO_ASSETS, VideoAssets try: from requests import get @@ -51,6 +50,14 @@ def download_assets(asset_name: Union[VideoAssets, str]) -> str: Returns: str: The filename of the downloaded asset. + + Example: + ```python + >>> from supervision.assets import download_assets, VideoAssets + + >>> download_assets(VideoAssets.VEHICLES) + "vehicles.mp4" + ``` """ filename = asset_name.value if isinstance(asset_name, VideoAssets) else asset_name