#benchmark #criterion #cargo #reporting #performance #running #extension

app cargo-criterion

Cargo扩展,用于运行Criterion.rs基准测试并报告结果

7个版本 (3个稳定版)

1.1.0 2021年7月28日
1.0.1 2021年1月25日
1.0.0 2020年7月19日
1.0.0-alpha12020年6月29日
0.0.1 2020年4月27日

#110 in 性能分析

Download history 1170/week @ 2024-04-08 906/week @ 2024-04-15 828/week @ 2024-04-22 644/week @ 2024-04-29 808/week @ 2024-05-06 900/week @ 2024-05-13 859/week @ 2024-05-20 681/week @ 2024-05-27 999/week @ 2024-06-03 839/week @ 2024-06-10 715/week @ 2024-06-17 683/week @ 2024-06-24 1001/week @ 2024-07-01 718/week @ 2024-07-08 793/week @ 2024-07-15 1407/week @ 2024-07-22

3,960 每月下载量

Apache-2.0/MIT

355KB
10K SLoC

cargo-criterion

Criterion-rs Cargo扩展

cargo-criterion是Cargo的一个插件,用于处理分析并报告Criterion-rs基准测试的大部分工作。

目录

特性

  • 图表:使用gnuplotplotters生成详细的基准测试结果图表
  • 报告:除了由Criterion.rs生成的报告外,cargo-criterion还生成一个历史报告,显示函数随时间的变化性能。
  • 可配置:cargo-criterion的图表生成可以通过criterion.toml文件进行配置。

快速入门

这假设你已经有了使用Criterion-rs的基准测试。如果没有,请参阅Criterion-rs快速入门指南。注意,建议使用 Criterion.rs 版本 0.3.3 或更高版本。不使用 Criterion.rs 或使用早期版本的基准测试将正常运行,但无法享受 cargo-criterion 的一些功能。

首先安装 cargo-criterion

cargoinstall cargo-criterion

然后你可以使用它来运行你的 Criterion.rs 基准测试

cargocriterion

目标

  • cargo-criterion旨在提高 Criterion-rs 基准测试的迭代时间。通过将功能移动到一个可一次性安装和重用的单独的可执行文件中,Criterion-rs 可以缩小 - 意味着需要编译和链接到基准测试本身的代码更少。
  • 由于 cargo-criterion 可以从头到尾监控基准测试的全过程,因此更适合提供在 Criterion-rs 中难以实现的功能。这些包括
    • 机器可读输出
    • 随时间跟踪基准性能

贡献

首先,感谢您的贡献。

为 cargo-criterion 做出贡献的一个好方法是将它用于自己的基准测试需求,并报告您的经验,提交和评论问题等。

以拉取请求的形式提交的代码或文档改进也受欢迎。如果您不确定要做什么,可以尝试检查 初学者标签

如果您的問題或拉取请求几天后没有回应,请随时提醒我 (@bheisler)。

有关更多详细信息,请参阅 CONTRIBUTING.md 文件

兼容性策略

cargo-criterion 支持 Rust 的最后三个稳定次要版本。撰写本文时,这意味着 Rust 1.50 或更高版本。旧版本可能可以工作,但未经测试或保证。

目前,认为可以工作的 Rust 最低版本是 1.46。cargo-criterion 的未来版本可能会停止支持这些旧版本,但这不会被视为破坏性变更。如果您需要 cargo-criterion 在 Rust 的旧版本上工作,您将需要坚持使用 cargo-criterion 的特定补丁版本。

维护

cargo-criterion 最初由 Brook Heisler (@bheisler) 开发并维护。

许可

cargo-criterion 在 Apache 2.0 许可证和 MIT 许可证下双许可。

依赖关系

~6–16MB
~195K SLoC