From bb18de8dcea42b3bc38ee357ad307e6daf340c34 Mon Sep 17 00:00:00 2001 From: SkalskiP Date: Wed, 28 Jun 2023 19:47:23 +0200 Subject: [PATCH] ready for tests --- supervision/utils/video.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/supervision/utils/video.py b/supervision/utils/video.py index 89a4fd1c..b70a82fb 100644 --- a/supervision/utils/video.py +++ b/supervision/utils/video.py @@ -123,6 +123,14 @@ def get_video_frames_generator( end (int): Indicates the ending position at which video should stop generating frames Returns: (Generator[np.ndarray, None, None]): A generator that yields the frames of the video. + + Examples: + ```python + >>> import supervision as sv + + >>> for frame in sv.get_video_frames_generator(source_path='source_video.mp4'): + ... ... + ``` """ video, start, end = _validate_and_setup_video(source_path, start, end) frame_position = start