v1.4.0

.github/actions/python-poetry/action.yml

@@ -34,5 +34,6 @@ runs:
         path: .venv
         key: ${{ runner.os }}-poetry-${{ inputs.poetry-version }}-${{ hashFiles('**/poetry.lock') }}
     - name: Install dependencies
-      run: poetry install --no-interaction --no-root --only ${{ inputs.groups }}
+      run:
+        poetry install --no-interaction --no-root --only ${{ inputs.groups }}
       shell: bash

.github/workflows/ci.yml

@@ -21,11 +21,11 @@ jobs:
       - name: Set up Python and Poetry
         uses: ./.github/actions/python-poetry
         with:
-          groups: dev
+          groups: main,dev,test
       - name: Run pre-commit
         uses: pre-commit/action@v3.0.1
-      # - name: Run tests
-      #   run: poetry run python -m pytest
+      - name: Run tests
+        run: poetry run python -m pytest
 
   build:
     runs-on: ubuntu-latest

.github/workflows/docs.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+  workflow_call:
 
 permissions:
   contents: write
@@ -22,6 +23,10 @@ jobs:
         with:
           groups: "docs"
 
+      - name: Generate notebook examples
+        run: |
+          poetry run jupyter nbconvert --to markdown --allow-errors --output-dir docs/examples notebooks/*.ipynb
+
       - name: Deploy docs
         run: |
           poetry run mkdocs gh-deploy --force

.gitignore

@@ -9,3 +9,5 @@ dist/
 outputs/
 results/
 poetry.lock
+CLAUDE.md
+**/CLAUDE.local.md

README.md

@@ -1,19 +1,33 @@
 ![promptolution](https://github.com/user-attachments/assets/84c050bd-61a1-4f2e-bc4e-874d9b4a69af)
+
+[![CI](https://github.com/finitearth/promptolution/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/finitearth/promptolution/actions/workflows/ci.yml)
+[![Docs](https://github.com/finitearth/promptolution/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/finitearth/promptolution/actions/workflows/docs.yml)
+
 # Promptolution
 Promptolution is a library that provides a modular and extensible framework for implementing prompt tuning experiments. It offers a user-friendly interface to assemble the core components for various prompt optimization tasks.
 
 In addition, this repository contains our experiments for the paper "Towards Cost-Effective Prompt Tuning: Evaluating the Effects of Model Size, Model Family and Task Descriptions in EvoPrompt".
 
 This project was developed by [Timo Heiß](https://www.linkedin.com/in/timo-heiss/), [Moritz Schlager](https://www.linkedin.com/in/moritz-schlager/) and [Tom Zehle](https://www.linkedin.com/in/tom-zehle/).
 
+## Getting Started
+Take a look at our getting started notebook: [getting_started.ipynb](https://github.com/finitearth/promptolution/blob/main/notebooks/getting_started.ipynb)
+
 ## Installation
 
 Use pip to install our library:
 
 ```
-pip install promptolution
+pip install promptolution[api]
+```
+
+If you want to run your prompt optimization locally, either via transformers or vLLM, consider running:
+
+```
+pip install promptolution[vllm,transformers]
 ```
 
+
 Alternatively, clone the repository, run
 
 ```
@@ -58,17 +72,5 @@ Create API Keys for the models you want to use:
 - Detailed logging and callback system for optimization analysis
 
 
-## Getting Started
-Take a look at our getting started notebook: [getting_started.py](https://github.com/finitearth/promptolution/blob/main/notebooks/getting_started.ipynb)
-## Reproduce our Experiments
-
-We provide scripts and configs for all our experiments. Run experiments based on config via:
-
-```
-poetry run python scripts/experiment_runs.py --experiment "configs/<my_experiment>.ini"
-```
-where `<my_experiment>.ini` is a config based on our templates.
-
-
 
-This project was developed for seminar "AutoML in the age of large pre-trained models" at LMU Munich.
+This project was developed for the "AutoML in the age of large pre-trained models" seminar at LMU Munich.

docs/api/config.md

@@ -1,6 +1,6 @@
 # Config
 
-::: promptolution.config.Config
+::: promptolution.config.ExperimentConfig
     options:
       show_root_heading: true
       show_root_full_path: false