Repository navigation
v0.0.4 - Add MSRV badge to README and create rustfmt configuration file (#9)
🌟 Summary
v0.0.4 turns the Ultralytics Rust template into a more reliable, performance‑aware, and contributor‑friendly project by standardizing tooling (MSRV, formatting), adding benchmark infrastructure, and improving crate discoverability. 🚀
📊 Key Changes
-
🦀 Explicit Rust MSRV & Tooling (PR #9 – primary change)
- Added
.clippy.tomlwithmsrv = "1.91"to lock in the minimum supported Rust version. - Introduced
rustfmt.tomlwith consistent, opinionated formatting (2024 edition, wrapped comments, normalized docs, grouped imports). - Updated
README.mdwith an MSRV badge that links directly toCargo.toml. - Bumped crate version from
0.0.3➜0.0.4.
- Added
-
🏎️ Criterion.rs Benchmarking Support (PR #10)
- Added
criterionas a dev dependency with HTML report support. - Registered a new
example_benchtarget and implementedbenches/example_bench.rsbenchmarking theadd_numbersfunction. - Created
benches/README.mdwith clear instructions for running, viewing, and extending benchmarks. - Updated
.gitignoreto exclude/target/criterion/(benchmark output) and.cargo-deny/.
- Added
-
🔍 Improved Crate Metadata & Discoverability (PR #11)
- Updated
keywordsto emphasizeultralytics,ml,ai, andyolo. - Expanded
categoriesto includescienceandcomputer-visionalongsidedevelopment-tools.
- Updated
🎯 Purpose & Impact
-
✅ Clear compatibility expectations
- The explicit MSRV (Rust 1.91) and badge make it easy for users and CI systems to know which Rust version is required, avoiding build surprises and version mismatches.
-
✅ Consistent, clean code for all contributors
- Project-wide
rustfmtsettings and Clippy MSRV alignment ensure everyone formats code the same way, reducing “style-only” diffs and speeding up reviews.
- Project-wide
-
📈 Built-in performance benchmarking
- Criterion-based benchmarks let you measure how fast your code runs and how it changes over time, with HTML reports that are easy to explore.
- The included
example_benchandbenches/README.mdserve as a template so you can quickly add your own benchmarks.
-
🤝 Easier discovery in the Rust + AI ecosystem
- Improved keywords and categories help developers on crates.io quickly recognize this as an Ultralytics-style AI/ML and computer vision template, making it more likely to be found and adopted.
-
🚀 Stronger foundation for future AI/ML Rust projects
- With standard tooling, performance tracking, and clearer positioning, v0.0.4 is a more robust starting point for building production-grade Rust integrations in the Ultralytics ecosystem.
What's Changed
- Update Cargo.toml keywords and categories by @glenn-jocher in #11
- feat :🏎️ Add benchmarking support with Criterion.rs and example benchmarks by @onuralpszr in #10
- Add MSRV badge to README and create rustfmt configuration file by @onuralpszr in #9
Full Changelog: v0.0.3...v0.0.4