Skip to content

Commit

Permalink
Updated README and version
Browse files Browse the repository at this point in the history
  • Loading branch information
fjwillemsen committed May 17, 2024
1 parent cc086fc commit 1c096e7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
This repository contains the software package accompanying the paper "A Methodology for Comparing Auto-Tuning Optimization Algorithms".
It makes the guidelines in the methodology easy to apply: simply specify the `.json` file, run `autotuning_visualize [path_to_json]` and wait for the results!

### Limitations & Future Work
Currently, the stable releases of this software package are compatible with [Kernel Tuner](https://github.com/KernelTuner/kernel_tuner) and [KTT](https://github.com/HiPerCoRe/KTT), as in the paper. We plan to soon extend this to support more frameworks.

## Installation
The package can be installed with `pip install autotuning_methodology`.
Alternatively, it can be installed by cloning this repository and running `pip install .` in the root of the cloned project.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ requires = ["flit_core >=3.8.0,<4"]

[project] # https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata
name = "autotuning_methodology"
version = "1.0.0b2"
version = "1.0.0b3"
authors = [{ name = "Floris-Jan Willemsen", email = "fjwillemsen97@gmail.com" }]
description = "Software package easing implementation of the guidelines of the 2024 paper 'A Methodology for Comparing Auto-Tuning Optimization Algorithms'."
keywords = ["autotuning", "auto-tuning", "methodology", "scientific"]
Expand Down

0 comments on commit 1c096e7

Please sign in to comment.