Skip to content

Commit 4908e9f

Browse files
committed
Add comment to point to actual docstring
1 parent 69686cb commit 4908e9f

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

src/torchcodec/samplers/_index_based.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ def clips_at_random_indices(
195195
sampling_range_end: Optional[int] = None, # interval is [start, end).
196196
policy: Literal["repeat_last", "wrap", "error"] = "repeat_last",
197197
) -> FrameBatch:
198+
# See docstring below
198199
return _generic_index_based_sampler(
199200
kind="random",
200201
decoder=decoder,
@@ -217,6 +218,7 @@ def clips_at_regular_indices(
217218
sampling_range_end: Optional[int] = None, # interval is [start, end).
218219
policy: Literal["repeat_last", "wrap", "error"] = "repeat_last",
219220
) -> FrameBatch:
221+
# See docstring below
220222
return _generic_index_based_sampler(
221223
kind="regular",
222224
decoder=decoder,

src/torchcodec/samplers/_time_based.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ def clips_at_random_timestamps(
229229
sampling_range_end: Optional[float] = None, # interval is [start, end).
230230
policy: Literal["repeat_last", "wrap", "error"] = "repeat_last",
231231
) -> FrameBatch:
232+
# See docstring below
232233
return _generic_time_based_sampler(
233234
kind="random",
234235
decoder=decoder,
@@ -253,6 +254,7 @@ def clips_at_regular_timestamps(
253254
sampling_range_end: Optional[float] = None, # interval is [start, end).
254255
policy: Literal["repeat_last", "wrap", "error"] = "repeat_last",
255256
) -> FrameBatch:
257+
# See docstring below
256258
return _generic_time_based_sampler(
257259
kind="regular",
258260
decoder=decoder,

0 commit comments

Comments
 (0)