From 1c096e7ceabed2ffed53838a052c7188ac93124d Mon Sep 17 00:00:00 2001 From: Floris-Jan Willemsen Date: Fri, 17 May 2024 08:47:37 +0200 Subject: [PATCH] Updated README and version --- README.md | 3 +++ pyproject.toml | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cab424..90eaa7d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 4a37a8b..1a26efc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]