|author||Austin Clements <firstname.lastname@example.org>||Wed Nov 03 22:04:06 2021 -0400|
|committer||Austin Clements <email@example.com>||Fri Apr 01 18:04:28 2022 +0000|
README.md: update for new packages and tools The last several CLs overhauled x/perf. Update README.md to reflect the new packages and tools as well as deprecated packages. Change-Id: Ic0f7d1921412f5af8c55c2b420e19e5a39da1eaf Reviewed-on: https://go-review.googlesource.com/c/perf/+/361198 Trust: Austin Clements <firstname.lastname@example.org> Reviewed-by: Russ Cox <email@example.com> Reviewed-by: Michael Knyszek <firstname.lastname@example.org> Run-TryBot: Austin Clements <email@example.com> TryBot-Result: Gopher Robot <firstname.lastname@example.org>
This subrepository holds tools and packages for analyzing Go benchmark results, such as the output of testing package benchmarks.
This subrepository contains command-line tools for analyzing benchmark result data.
cmd/benchstat computes statistical summaries and A/B comparisons of Go benchmarks.
cmd/benchsave publishes benchmark results to perf.golang.org.
To install all of these commands, run
go install golang.org/x/perf/cmd/...@latest. You can also
git clone https://go.googlesource.com/perf and run
go install ./cmd/... in the checkout.
Underlying the above tools are several packages for working with benchmark data. These are designed to work together, but can also be used independently.
benchfmt reads and writes the Go benchmark format.
benchunit manipulates benchmark units and formats numbers in those units.
benchproc provides tools for filtering, grouping, and sorting benchmark results.
benchmath provides tools for computing statistics over distributions of benchmark measurements.
The following packages are deprecated and no longer supported:
storage contains a deprecated version of the https://perfdata.golang.org/ benchmark result storage system. These packages have moved to https://golang.org/x/build.
analysis contains a deprecated version of the https://perf.golang.org/ benchmark result analysis system. These packages have moved to https://golang.org/x/build.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the perf repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/perf:” in the subject line, so it is easy to find.