Skip to content

Commit 289b9a1

Browse files
authored
Removing asv file plus docs update (#769)
1 parent 7f31435 commit 289b9a1

File tree

8 files changed

+10
-290
lines changed

8 files changed

+10
-290
lines changed

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ test_results/
5050
junit/
5151
.hypothesis/
5252

53-
# Airspeed velocity
54-
.asv/
55-
5653
# Translations
5754
*.mo
5855
*.pot

asv.conf.json

-36
This file was deleted.

benchmarks_original/benchmark_coo.py

-73
This file was deleted.

benchmarks_original/benchmark_gcxs.py

-94
This file was deleted.

benchmarks_original/benchmark_matmul.py

-22
This file was deleted.

benchmarks_original/benchmark_tensordot.py

-57
This file was deleted.

docs/contributing.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,16 @@ mkdocs serve
110110

111111
After this, you can see a version of the documentation on your local server.
112112

113-
Documentation for pull requests is automatically built on CircleCI and can be found in the build
114-
artifacts.
113+
Documentation for each pull requests is automatically built on `Read the Docs`.
114+
It is rebuilt with every new commit to your PR. There will be a link to preview it
115+
from your PR checks area on `GitHub` when ready.
116+
115117

116118
## Adding and Running Benchmarks
117119

118-
We use [Airspeed Velocity](https://asv.readthedocs.io/en/latest) to run benchmarks. We have it set
119-
up to use `conda`, but you can edit the configuration locally if you so wish.
120+
We use [`CodSpeed`](https://docs.codspeed.io/) to run benchmarks. They are run in the CI environment
121+
when a pull request is opened. Then the results of the run are sent to `CodSpeed` servers to be analyzed.
122+
When the analysis is done, a report is generated and posted automatically as a comment to the PR.
123+
The report includes a link to `CodSpeed`cloud where you can see the all the results.
124+
125+
If you add benchmarks, they should be written as regular tests to be used with pytest, and use the fixture `benchmark`. Please see the `CodSpeed`documentation for more details.

setup.cfg

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
# Note: there cannot be spaces after comma's here
77
exclude =
88
__init__.py
9-
.asv/
109
.tox/
1110

1211

0 commit comments

Comments
 (0)