https://github.com/haozeke/asv_bench_memray

A memray benchmark plugin for asv
https://github.com/haozeke/asv_bench_memray

asv benchmark memory-testing

Last synced: 22 days ago
JSON representation

A memray benchmark plugin for asv

• Host: GitHub
• URL: https://github.com/haozeke/asv_bench_memray
• Owner: HaoZeke
• License: mit
• Created: 2023-05-21T23:35:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-11T21:29:47.000Z (9 months ago)
• Last Synced: 2024-09-18T02:54:55.383Z (about 2 months ago)
• Topics: asv, benchmark, memory-testing
• Language: Python
• Homepage: https://haozeke.github.io/asv_bench_memray/
• Size: 1.85 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# asv_bench_memray

This a proof-of-concept externally defined `memray` **benchmark plugin** for `asv`.

## Usage

In your `asv.conf.json` add the following to the requirements matrix:

``` json-with-comments

"matrix": {

    "req": {

        "numpy": ["1.21"],

        "asv_plugin_memray": [""]

    },

},

```

This should be enough for an example like the following to run:

``` python

import numpy as np

class MyBenchmark:

    params = [10, int(2e4)]

    def ray_sum(self, n):

        self.data = np.random.rand(n)

        np.sum(self.data)

```

Which should result in something roughly like:

```sh

ASV_RUNNER_PATH="../asv_runner" asv run --bench sum

· Creating environments.......

· Discovering benchmarks

·· Uninstalling from virtualenv-py3.9-asv_bench_memray.._asv_bench_memray-numpy1.21

·· Building 30a650cb  for virtualenv-py3.9-asv_bench_memray.._asv_bench_memray-numpy1.21.

·· Installing 30a650cb  into virtualenv-py3.9-asv_bench_memray.._asv_bench_memray-numpy1.21

· Running 1 total benchmarks (1 commits * 1 environments * 1 benchmarks)

[ 0.00%] · For project commit 30a650cb :

[ 0.00%] ·· Benchmarking virtualenv-py3.9-asv_bench_memray.._asv_bench_memray-numpy1.21

[100.00%] ··· benchmarks.MyBenchmark.ray_sum                                                ok

[100.00%] ··· ======== =======

               param1         

              -------- -------

                 10     1.72k 

               20000     162k 

              ======== =======

ASV_RUNNER_PATH="../asv_runner" asv run --bench sum  8.72s user 3.04s system 99% cpu 11.877 total

```

## Development

During development, one needs to pass a relative path:

``` json-with-comments

"matrix": {

    "req": {

        "asv_bench_memray": ["../asv_bench_memray"]

    },

},

```

Also it may be necessary to cleanup older environments and explicitly point to an instance of `asv_runner`:

``` sh

rm -rf .asv && ASV_RUNNER_PATH="../asv_runner" asv run --bench sum

```

Personally I keep benchmarks for testing at an [experiments repo](https://github.com/HaoZeke/asv_experiments), but any local test will do.

### Conventions

Like all externally defined benchmark plugins for `asv`, this has a strict hierarchy.

- [X] The package name begins with `asv_bench`

- [X] Benchmarks are defined in a `benchmarks` folder under the package module

- [X] Each exported new benchmark type has the `export_as_benchmark = [NAMEBenchmark]` attribute

For more conventions follow the documention of `asv_runner`.

# License

MIT.