Skip to content

Commit 7d17dd2

Browse files
fix(docs): typos in benchmark readme.md (huggingface#614)
Co-authored-by: Simon Alibert <75076266+aliberts@users.noreply.github.com>
1 parent d6b1412 commit 7d17dd2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

benchmarks/video/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ How to decode videos?
2121

2222
## Variables
2323
**Image content & size**
24-
We don't expect the same optimal settings for a dataset of images from a simulation, or from real-world in an appartment, or in a factory, or outdoor, or with lots of moving objects in the scene, etc. Similarly, loading times might not vary linearly with the image size (resolution).
24+
We don't expect the same optimal settings for a dataset of images from a simulation, or from real-world in an apartment, or in a factory, or outdoor, or with lots of moving objects in the scene, etc. Similarly, loading times might not vary linearly with the image size (resolution).
2525
For these reasons, we run this benchmark on four representative datasets:
2626
- `lerobot/pusht_image`: (96 x 96 pixels) simulation with simple geometric shapes, fixed camera.
2727
- `aliberts/aloha_mobile_shrimp_image`: (480 x 640 pixels) real-world indoor, moving camera.
@@ -63,7 +63,7 @@ This of course is affected by the `-g` parameter during encoding, which specifie
6363

6464
Note that this differs significantly from a typical use case like watching a movie, in which every frame is loaded sequentially from the beginning to the end and it's acceptable to have big values for `-g`.
6565

66-
Additionally, because some policies might request single timestamps that are a few frames appart, we also have the following scenario:
66+
Additionally, because some policies might request single timestamps that are a few frames apart, we also have the following scenario:
6767
- `2_frames_4_space`: 2 frames with 4 consecutive frames of spacing in between (e.g `[t, t + 5 / fps]`),
6868

6969
However, due to how video decoding is implemented with `pyav`, we don't have access to an accurate seek so in practice this scenario is essentially the same as `6_frames` since all 6 frames between `t` and `t + 5 / fps` will be decoded.
@@ -85,8 +85,8 @@ However, due to how video decoding is implemented with `pyav`, we don't have acc
8585
**Average Structural Similarity Index Measure (higher is better)**
8686
`avg_ssim` evaluates the perceived quality of images by comparing luminance, contrast, and structure. SSIM values range from -1 to 1, where 1 indicates perfect similarity.
8787

88-
One aspect that can't be measured here with those metrics is the compatibility of the encoding accross platforms, in particular on web browser, for visualization purposes.
89-
h264, h265 and AV1 are all commonly used codecs and should not be pose an issue. However, the chroma subsampling (`pix_fmt`) format might affect compatibility:
88+
One aspect that can't be measured here with those metrics is the compatibility of the encoding across platforms, in particular on web browser, for visualization purposes.
89+
h264, h265 and AV1 are all commonly used codecs and should not pose an issue. However, the chroma subsampling (`pix_fmt`) format might affect compatibility:
9090
- `yuv420p` is more widely supported across various platforms, including web browsers.
9191
- `yuv444p` offers higher color fidelity but might not be supported as broadly.
9292

@@ -116,7 +116,7 @@ Additional encoding parameters exist that are not included in this benchmark. In
116116
- `-preset` which allows for selecting encoding presets. This represents a collection of options that will provide a certain encoding speed to compression ratio. By leaving this parameter unspecified, it is considered to be `medium` for libx264 and libx265 and `8` for libsvtav1.
117117
- `-tune` which allows to optimize the encoding for certains aspects (e.g. film quality, fast decoding, etc.).
118118

119-
See the documentation mentioned above for more detailled info on these settings and for a more comprehensive list of other parameters.
119+
See the documentation mentioned above for more detailed info on these settings and for a more comprehensive list of other parameters.
120120

121121
Similarly on the decoding side, other decoders exist but are not implemented in our current benchmark. To name a few:
122122
- `torchaudio`

0 commit comments

Comments
 (0)