Skip to content

Commit c1d81d5

Browse files
committed
Update README with performance section and image
Added performance benchmark image to README.
1 parent 5e0e3e4 commit c1d81d5

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,4 @@ poetry.lock
8080

8181
# scikit-build
8282
_cmake_test_compile/
83+
.github/instructions/keep-it-clean.instructions.md

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,7 @@ with viteo.open("video.mp4", batch_size=2) as frames:
8383
for frame in frames:
8484
process(frame)
8585
```
86+
87+
## Performance
88+
89+
<img width="3568" height="2068" alt="benchmark_comparison" src="https://github.com/user-attachments/assets/51a7c00c-8777-4ccc-a7fb-8ae69f156afe" />

pyproject.toml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[build-system]
2-
requires = ["scikit-build-core>=0.8.0", "nanobind>=2.9.0", "setuptools>=80.0"]
2+
requires = ["scikit-build-core", "nanobind", "setuptools"]
33
build-backend = "scikit_build_core.build"
44

55
[project]
@@ -36,17 +36,17 @@ classifiers = [
3636
"Topic :: Software Development :: Libraries :: Python Modules",
3737
]
3838
dependencies = [
39-
"mlx>=0.5.0",
39+
"mlx",
4040
]
4141

4242
[project.optional-dependencies]
4343
dev = [
44-
"pytest>=8.0",
45-
"opencv-python>=4.8.0",
44+
"pytest",
45+
"opencv-python",
4646
]
4747
test = [
48-
"pytest>=8.0",
49-
"opencv-python>=4.8.0",
48+
"pytest",
49+
"opencv-python",
5050
]
5151

5252
[project.urls]
@@ -56,10 +56,8 @@ Documentation = "https://github.com/codeSamuraii/viteo#readme"
5656
Issues = "https://github.com/codeSamuraii/viteo/issues"
5757

5858
[tool.scikit-build]
59-
cmake.version = ">=3.18"
6059
cmake.build-type = "Release"
6160
wheel.packages = ["src/viteo"]
62-
minimum-version = "0.8.0"
6361

6462
[tool.scikit-build.cmake.define]
6563
CMAKE_OSX_ARCHITECTURES = "arm64"

0 commit comments

Comments
 (0)