diff --git a/docs/assets.md b/docs/assets.md new file mode 100644 index 00000000..1a194a62 --- /dev/null +++ b/docs/assets.md @@ -0,0 +1,7 @@ +## download_assets + +:::supervision.assets.downloader.download_assets + +## VideoAssets + +:::supervision.assets.list.VideoAssets \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 6528b238..7d5b0b5e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,6 +53,7 @@ nav: - Image: utils/image.md - Notebook: utils/notebook.md - File: utils/file.md + - Assets: assets.md - Changelog: changelog.md theme: diff --git a/supervision/assets/__init__.py b/supervision/assets/__init__.py index 17119d2e..84f33869 100644 --- a/supervision/assets/__init__.py +++ b/supervision/assets/__init__.py @@ -1,2 +1,2 @@ -from .asset_list import VideoAssets +from .list import VideoAssets from .downloader import download_assets diff --git a/supervision/assets/downloader.py b/supervision/assets/downloader.py index e9c0d029..af24a290 100644 --- a/supervision/assets/downloader.py +++ b/supervision/assets/downloader.py @@ -5,7 +5,7 @@ from shutil import copyfileobj from typing import Union from supervision.assets import VideoAssets -from supervision.assets.asset_list import VIDEO_ASSETS +from supervision.assets.list import VIDEO_ASSETS try: from requests import Response, get diff --git a/supervision/assets/asset_list.py b/supervision/assets/list.py similarity index 51% rename from supervision/assets/asset_list.py rename to supervision/assets/list.py index d7ba5644..ec8dc47c 100644 --- a/supervision/assets/asset_list.py +++ b/supervision/assets/list.py @@ -5,6 +5,20 @@ BASE_VIDEO_URL = "https://media.roboflow.com/supervision/video-examples/" class VideoAssets(Enum): + """ #noqa + Each member of this enum represents a video asset. The value associated with each + member is the filename of the video. + + | Enum Member | Video Filename | Video URL | + |------------------------|----------------------------|---------------------------------------------------------------------------------------| + | `VEHICLES` | `vehicles.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/vehicles.mp4) | + | `MILK_BOTTLING_PLANT` | `milk-bottling-plant.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/milk-bottling-plant.mp4) | + | `VEHICLES_2` | `vehicles-2.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/vehicles-2.mp4) | + | `GROCERY_STORE` | `grocery-store.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/grocery-store.mp4) | + | `SUBWAY` | `subway.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/subway.mp4) | + | `MARKET_SQUARE` | `market-square.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/market-square.mp4) | + | `PEOPLE_WALKING` | `people-walking.mp4` | [Link](https://media.roboflow.com/supervision/video-examples/people-walking.mp4) | + """ VEHICLES = "vehicles.mp4" MILK_BOTTLING_PLANT = "milk-bottling-plant.mp4" VEHICLES_2 = "vehicles-2.mp4"