Skip to content

Commit c4595b2

Browse files
authored
add docstring
1 parent e5d10f7 commit c4595b2

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

dlclive/bench.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,11 @@ def benchmark_model_by_size(model_path, video_path, output=None, n_frames=10000,
228228
list of pixel image sizes (as ints), can only use one of resize or pixels, if both specified will use pixels, by default None
229229
print_rate : bool, optional
230230
flag to print frame by frame inference rate, by default False
231+
232+
Example
233+
--------
234+
Linux/MacOs
235+
dlclive.bench.benchmark_model_by_size('/path/to/pbfiles/', '/pathto/video.mp4', n_frames=10000, print_rate=True)
231236
"""
232237

233238
### fix resize

0 commit comments

Comments
 (0)