Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: Config benchmarks to work with asv again #124

Merged
merged 2 commits into from
May 4, 2024
Merged

MAINT: Config benchmarks to work with asv again #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db00ce1
MAINT/BENCH: Configure benchmark to work with conda
Kai-Striega May 4, 2024
646f292
DOC/BENCH: Remove poetry from benchmarking documentation
Kai-Striega May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion asv.conf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

// List of branches to benchmark. If not provided, defaults to "master"
// (for git) or "default" (for mercurial).
"branches": ["main"],
"branches": ["HEAD"],

// The DVCS being used. If not set, it will be automatically
// determined from "repo" by looking at the protocol in the URL
Expand Down
18 changes: 4 additions & 14 deletions doc/source/dev/running_the_benchmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,12 @@

This document outlines how to setup and run the benchmarks using [asv](https://asv.readthedocs.io/en/v0.6.1/).

## Installing asv

`asv` can be installed with poetry via the `bench` group to install the bench group run:

```shell
poetry install --with=bench
```

This will install ``asv`` into your poetry environment.

## Running the benchmarks

To run the benchmarks with ``asv``, simply enter:

```shell
poetry run asv run
asv run
```

## Viewing the results
Expand All @@ -27,13 +17,13 @@ There are two steps to viewing the results locally. The results need to be publi
To publish the results use:

```shell
poetry run asv publish
asv publish
```

And then to view the results:

```shell
poetry run asv preview
asv preview
```

This will launch a local web browser from which you can view the results
Expand All @@ -43,7 +33,7 @@ This will launch a local web browser from which you can view the results
One common use case is to use ``asv`` in development, there are several useful flags that should be used:

```shell
poetry run asv --python=same --quick --dry-run
asv --python=same --quick --dry-run
```

We are adding three flags, these flags are:
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ name = "numpy-financial"
version = "2.0.0"
requires-python = ">=3.10"
description = "Simple financial functions"
license = "BSD-3-Clause"
authors = ["Travis E. Oliphant et al."]
maintainers = ["Numpy Financial Developers <numpy-discussion@python.org>"]
license = {file = "LICENSE.txt"}
authors = [{name = "Travis E. Oliphant et al."}]
maintainers = [{ name = "Numpy Financial Developers", email = "numpy-discussion@python.org" }]
readme = "README.md"
homepage = "https://numpy.org/numpy-financial/latest/"
repository = "https://github.com/numpy/numpy-financial"
Expand Down
Loading