Skip to content

Commit

Permalink
DOC: Detail external plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoZeke committed Feb 1, 2024
1 parent d2a7938 commit 5e63cb3
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/bplugin-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# External Plugin List

Here are the existing external plugins which are supported by `asv` and
`asv_runner` (pull requests welcome).

## Benchmark Plugins

- [`asv_bench_memray`](https://haozeke.github.io/asv_bench_memray/) enables
`RayMyClass` or `ray_funcname` for peak memory as profiled by `memray`, which
is able to handle native calls and traces every function call
9 changes: 9 additions & 0 deletions docs/source/development/benchmark_plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Developing benchmarks

All benchmark plugins must follow a strict hierarchy:

- The package name must begin with `asv_bench`.
- Benchmark classes are defined in a `benchmarks` folder under the package module.
- Each exported new benchmark type has the `export_as_benchmark = [NAMEBenchmark]` attribute.

For more conventions, see the internally defined benchmark types within `asv_runner`.
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ measure and analyze the performance of your Python packages.
:caption: Contents
apidocs/index
bplugin-list
```

## Indices and tables
Expand Down

0 comments on commit 5e63cb3

Please sign in to comment.