neurostuff / NiMARE

Coordinate- and image-based meta-analysis in Python
https://nimare.readthedocs.io
MIT License
182 stars 58 forks source link

run benchmarking on estimators #900

Closed jdkent closed 3 months ago

jdkent commented 3 months ago

Closes # .

Changes proposed in this pull request:

-

Summary by Sourcery

Add benchmarking capabilities for CBMA estimators using ASV and set up a GitHub Actions workflow to automate the benchmarking process on the main branch and pull requests.

New Features:

CI:

sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request introduces benchmarking capabilities to the NiMARE project. It adds configuration files for the Airspeed Velocity (ASV) benchmarking tool, implements benchmarks for Coordinate-Based Meta-Analysis (CBMA) estimators, and sets up a GitHub Actions workflow to run these benchmarks automatically on pull requests and pushes to the main branch.

File-Level Changes

Files Changes
asv.conf.json Added ASV configuration file with project-specific settings and customizations
benchmarks/bench_cbma.py Implemented benchmarks for CBMA estimators including ALE, KDA, MKDAChi2, and MKDADensity
.github/workflows/benchmark.yml Created a GitHub Actions workflow to automatically run benchmarks on pull requests and pushes to the main branch

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.