Skip to content

Commit 75bca2a

Browse files
authored
Revise README for rebuilding and batch size info
Updated rebuilding instructions and added batch size details.
1 parent 59a2a8d commit 75bca2a

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,13 @@ cd viteo
5151
pip install -v -e .
5252
```
5353

54-
#### Rebuilding
55-
54+
To rebuild after changes:
5655
```bash
57-
rm -rf dist/
5856
pip install -e . --force-reinstall --no-deps
5957
```
6058

6159
## Configuration
60+
### Logging
6261

6362
You can enable debug logging with the `VITEO_DEBUG` environment variable:
6463
```bash
@@ -74,11 +73,13 @@ $ VITEO_DEBUG=1 python example.py video_1080p.mp4
7473
...
7574
```
7675

76+
### Batch size
77+
7778
Internally, `viteo` passes frames to Python in batches for performance.
7879
The default batch size is 8 frames, but you can change it by passing the `batch_size` argument:
7980
```python
80-
# Use larger batch size for better performance
81-
with viteo.open("video.mp4", batch_size=16) as frames:
81+
# Values between 2 and 16 are optimal
82+
with viteo.open("video.mp4", batch_size=2) as frames:
8283
for frame in frames:
8384
process(frame)
84-
```
85+
```

0 commit comments

Comments
 (0)