From 4d2c42ba960ece6aa938d28e2a367fe3c5452308 Mon Sep 17 00:00:00 2001 From: Floris-Jan Willemsen Date: Fri, 17 May 2024 10:00:08 +0200 Subject: [PATCH] Added Research Software Directory description, added DOI shield to readme --- README.md | 1 + docs/rsd_description.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 docs/rsd_description.md diff --git a/README.md b/README.md index 90eaa7d..c917787 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ [![Python Versions](https://img.shields.io/pypi/pyversions/autotuning_methodology)](https://pypi.org/project/autotuning_methodology/) [![PyPI Downloads](https://img.shields.io/pypi/dm/autotuning_methodology)](https://pypi.org/project/autotuning_methodology/) ![PyPI - Status](https://img.shields.io/pypi/status/autotuning_methodology) +![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11207515.svg) This repository contains the software package accompanying the paper "A Methodology for Comparing Auto-Tuning Optimization Algorithms". diff --git a/docs/rsd_description.md b/docs/rsd_description.md new file mode 100644 index 0000000..d4a2eba --- /dev/null +++ b/docs/rsd_description.md @@ -0,0 +1,12 @@ +- Official software by the authors of the article "A Methodology for Comparing Auto-Tuning Optimization Algorithms", making the guidelines in the methodology easy to apply. +- Supports [BAT benchmark suite](https://github.com/NTNU-HPC-Lab/BAT), [Kernel Tuner](https://github.com/KernelTuner/kernel_tuner) and [KTT](https://github.com/HiPerCoRe/KTT). +- Split executer and visualizer to allow running the algorithms on a cluster and visualize locally. +- Checkpointing built-in to avoid duplicate executions. +- Support for the standardised 'T4' output files. +- Notebook / interactive window mode; if enabled, plots are shown in the notebook / window instead of written to a folder. + +![Documentation](https://img.shields.io/badge/docs-available-brightgreen?link=https%3A%2F%2Fautotuningassociation.github.io%2Fautotuning_methodology%2F) +[![PyPI Downloads](https://img.shields.io/pypi/dm/autotuning_methodology)](https://pypi.org/project/autotuning_methodology/) +![PyPI - Status](https://img.shields.io/pypi/status/autotuning_methodology) +[![Python Versions](https://img.shields.io/pypi/pyversions/autotuning_methodology)](https://pypi.org/project/autotuning_methodology/) +![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11207515.svg) \ No newline at end of file