Chore/new release (#76)

* new read me

* publications

* contribution md

* clean up

* release notes

* Update CONTRIBUTING.md

Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com>

* change version

* Update coverage badge in README [skip ci]

---------

Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com>
Co-authored-by: finitearth <finitearth@users.noreply.github.com>

Author: finitearth

.coverage

@@ -0,0 +1,27 @@
+# 🤝 Contributing to Promptolution
+
+Thank you for your interest in contributing! Here's how to get started.
+
+## Workflow
+
+Open an issue → create a branch → PR → CI → review (by owner) → merge (by owner) → release (by owner)
+
+Branch naming: `feature/...`, `fix/...`, `chore/...`, `refactor/...`.
+
+## Code Quality
+
+Please ensure to use pre-commit, which assists with keeping the code quality high:
+
+```
+pre-commit install
+pre-commit run --all-files
+```
+
+## Tests
+
+We encourage every contributor to also write tests that automatically check if the implementation works as expected:
+
+```
+poetry run python -m coverage run -m pytest
+poetry run python -m coverage report -i
+```

CONTRIBUTING.md

@@ -2,8 +2,9 @@
 ![Coverage](https://img.shields.io/badge/Coverage-96%25-brightgreen)
 [![CI](https://github.com/automl/promptolution/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/automl/promptolution/actions/workflows/ci.yml)
 [![Docs](https://github.com/automl/promptolution/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/automl/promptolution/actions/workflows/docs.yml)
+[![PyPI version](https://img.shields.io/pypi/v/promptolution.svg)](https://pypi.org/project/promptolution/)
 ![Code Style](https://img.shields.io/badge/Code%20Style-black-black)
-![Python Versions](https://img.shields.io/badge/Python%20Versions-≥3.10-blue)
+![Python Versions](https://img.shields.io/badge/Python%20Versions-%E2%89%A53.10-blue)
 [![Getting Started](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/automl/promptolution/blob/main/tutorials/getting_started.ipynb)
 
 ![promptolution](https://github.com/user-attachments/assets/84c050bd-61a1-4f2e-bc4e-874d9b4a69af)
@@ -31,33 +32,46 @@
 
 Have a look at our [Release Notes](https://automl.github.io/promptolution/release-notes/) for the latest updates to promptolution.
 
-## 📦 Installation
+## 📚 Scientific Publications Powered by Promptolution
 
-```
-pip install promptolution[api]
-```
+- **CANTANTE: Optimizing Agentic Systems via Contrastive Credit Attribution** — Zehle, 2026. [arXiv](https://arxiv.org/abs/2605.13295)
+- **MO-CAPO: Multi-Objective Cost-Aware Prompt Optimization** — Büssing et al., 2026. [arXiv](https://arxiv.org/abs/2605.18869)
+- **promptolution: A Unified, Modular Framework for Prompt Optimization** — Zehle et al., 2026. [EACL 2026](https://aclanthology.org/2026.eacl-demo.21/)
+- **Can Calibration of Positional Encodings Enhance Long Context Utilization?** — Zehle & Aßenmacher, 2026. [EACL 2026](https://aclanthology.org/2026.findings-eacl.120/)
+- **Disambiguation-Centric Finetuning Makes Enterprise Tool-Calling LLMs More Realistic and Less Risky** — Hathidara et al., 2025. [arXiv](https://arxiv.org/abs/2507.03336)
+- **CAPO: Cost-Aware Prompt Optimization** — Zehle et al., 2025. [AutoML 2025](https://proceedings.mlr.press/v293/zehle25a.html)
 
-Local inference via vLLM or transformers:
+## 🔧 Installation and Quickstart
 
 ```
-pip install promptolution[vllm,transformers]
+pip install promptolution[api]
 ```
 
-From source:
+For local inference, add `[transformers]` (HuggingFace) or `[vllm]` (vLLM serving), or both.
 
-```
-git clone https://github.com/automl/promptolution.git
-cd promptolution
-poetry install
-```
+```python
+import pandas as pd
+from promptolution.utils import ExperimentConfig
+from promptolution.helpers import run_experiment
+
+# DataFrame with columns "x" (input) and "y" (label)
+df = pd.read_csv("your_data.csv")
 
-## 🔧 Quickstart
+config = ExperimentConfig(
+    optimizer="capo",
+    task_description="Classify each sentence as subjective or objective.",
+    prompts=["Classify the text as objective or subjective."],
+    n_steps=10,
+    api_url="https://api.openai.com/v1",
+    model_id="gpt-4o-mini",
+    api_key="YOUR_API_KEY",
+)
 
-Start with the **Getting Started tutorial**:
-[https://github.com/automl/promptolution/blob/main/tutorials/getting_started.ipynb](https://github.com/automl/promptolution/blob/main/tutorials/getting_started.ipynb)
+best_prompts = run_experiment(df, config)
+print(best_prompts)
+```
 
-Full docs:
-[https://automl.github.io/promptolution/](https://automl.github.io/promptolution/)
+Full tutorial: [Getting Started notebook](https://github.com/automl/promptolution/blob/main/tutorials/getting_started.ipynb) · [Docs](https://automl.github.io/promptolution/)
 
 
 ## 🧠 Featured Optimizers
@@ -69,6 +83,7 @@ Full docs:
 | `EvoPromptGA` | [Guo et al., 2023](https://openreview.net/forum?id=ZG3RaNIsO8)   | required         | 👍              | 💲💲      | ✅                  | ❌            |
 | `OPRO`        | [Yang et al., 2023](https://openreview.net/forum?id=Bb4VGOWELI)  | optional         | 👎              | 💲💲      | ❌                  | ❌            |
 
+
 ## 🏗 Components
 
 * **`Task`** – Manages the dataset, evaluation metrics, and subsampling.
@@ -79,20 +94,23 @@ Full docs:
 
 ## 🤝 Contributing
 
-Open an issue → create a branch → PR → CI → review → merge.
-Branch naming: `feature/...`, `fix/...`, `chore/...`, `refactor/...`.
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for the workflow, code quality guidelines, and how to run tests.
 
-Please ensure to use pre-commit, which assists with keeping the code quality high:
 
-```
-pre-commit install
-pre-commit run --all-files
-```
-We encourage every contributor to also write tests, that automatically check if the implementation works as expected:
+## 📄 Citation
 
+If you use Promptolution in your research, please cite:
+
+```bibtex
+@inproceedings{zehle2026promptolution,
+  title={promptolution: A unified, modular framework for prompt optimization},
+  author={Zehle, Tom and Hei{\ss}, Timo and Schlager, Moritz and A{\ss}enmacher, Matthias and Feurer, Matthias},
+  booktitle={Proceedings of the 19th Conference of the European Chapter of the Association for Computational Linguistics (Volume 3: System Demonstrations)},
+  pages={282--296},
+  year={2026}
+}
 ```
-poetry run python -m coverage run -m pytest
-poetry run python -m coverage report -i
-```
 
-Developed by **Timo Heiß**, **Moritz Schlager**, and **Tom Zehle** (LMU Munich, MCML, ELLIS, TUM, Uni Freiburg).
+---
+
+Developed    by **Timo Heiß**, **Moritz Schlager**, **Tom Zehle**, and **Henri Oberpaur** (LMU Munich, MCML, ELLIS, TUM, Uni Freiburg).

README.md

@@ -0,0 +1,17 @@
+## Release v2.2.3
+### What's changed
+
+#### Bug fixes:
+* Fixed list handling in local LLM response parsing — single-prompt batches were not unwrapped correctly
+* Fixed chat template handling for local LLMs (#72)
+* Fixed `ExperimentConfig` not being applied before resolving `x_column` in tasks (#68)
+* Fixed keyword handling in `RandomSearchSelector.select_exemplars` (#70)
+* Fixed various typos
+
+#### Further changes:
+* Added `CONTRIBUTING.md` with workflow, code quality, and testing guidelines
+* Added `accelerate` as a dependency of the `[transformers]` extra, enabling local inference without manual installation
+* Overhauled README: added quickstart code example, PyPI badge, installation guide, scientific publications section, and citation block
+* New tests now account for 96% test coverage
+
+**Full Changelog**: [here](https://github.com/automl/promptolution/compare/v2.2.2...v2.2.3)

docs/release-notes/v2.2.3.md

@@ -47,6 +47,7 @@ nav:
   - Home: index.md
   - Release Notes:
     - Overview: release-notes.md
+    - v2.2.3: release-notes/v2.2.3.md
     - v2.2.2: release-notes/v2.2.2.md
     - v2.2.1: release-notes/v2.2.1.md
     - v2.2.0: release-notes/v2.2.0.md

mkdocs.yml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "promptolution"
-version = "2.2.2"
+version = "2.2.3"
 description = "A framework for prompt optimization and a zoo of prompt optimization algorithms."
 authors = ["Tom Zehle, Moritz Schlager, Timo Heiß"]
 readme = "README.md"
@@ -16,12 +16,13 @@ openai = {version = ">=1.0.0", optional = true}
 requests = {version = ">=2.31.0", optional = true}
 vllm = {version = ">=0.13.0", optional = true}
 transformers = {version = ">=4.48.0", optional = true}
+accelerate = {version = ">=0.20.0", optional = true}
 scipy = ">=1.15"
 
 [tool.poetry.extras]
 api = ["openai", "requests"]
 vllm = ["vllm"]
-transformers = ["transformers"]
+transformers = ["transformers", "accelerate"]
 
 [tool.poetry.group.api]
 optional = true
@@ -38,6 +39,7 @@ vllm = ">=0.13.0"
 optional = true
 [tool.poetry.group.transformers.dependencies]
 transformers = ">=4.48.0"
+accelerate = ">=0.20.0"
 
 [tool.poetry.group.dev.dependencies]
 black = ">=24.4.2"