From 66d354557624388673e7cc5533dd9fce076ebd86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20Hei=C3=9F?= <87521684+timo282@users.noreply.github.com> Date: Sun, 13 Oct 2024 20:02:45 +0200 Subject: [PATCH 1/2] Update release-notes.md --- docs/release-notes.md | 67 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index ba6a637..b84126d 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,3 +1,68 @@ # Release Notes -coming soon... +## Release v0.2.0 + +### What's Changed +#### Added Features: +* Prompt creation utility function +* Prompt variation utility function +* New optimizer: OPro (https://arxiv.org/abs/2309.03409) + + +#### Further Changes: +* Workflows for automated build, deployment & release +* New documentation page appearance +* Additional Docstrings & Formatting + +**Full Changelog**: https://github.com/finitearth/promptolution/compare/v0.1.1...v0.2.0 + +## Release v0.1.1 (2) + +### What's Changed + +#### Added features: +\- + +#### Further changes: +* Added workflows for automated build, deployment, release and doc creation +* Updated pre-commits +* Added docstrings and formatting +* Updated readme +* Updated docs + +**Full Changelog**: https://github.com/finitearth/promptolution/compare/0.1.1...v0.1.1 + +## Release v0.1.1 + +### What's Changed + +#### Features added: +\- + +#### Further changes: +* Loosen restrictive python version requirements (^3.11 instead of ~3.11) +* Add documentation pages +* Update README + +**Full Changelog**: https://github.com/finitearth/promptolution/compare/0.1.0...0.1.1 + +## Release v0.1.0 + +*First release* + +### What's Changed + +#### Added Features: +* Base classes for tasks, LLMs, predictors, and optimizers +* Classification task +* API LLMs from OpenAI, Anthropic, and DeepInfra +* Local LLM +* optimizer EvoPrompt GA and EvoPrompt DE (https://arxiv.org/abs/2309.08532) + +#### Further changes: +* Added example classification datasets used in https://arxiv.org/abs/2309.08532 +* Added dummy classes for testing +* Added example scripts and configs for experiments +* Added experiment results and evaluation notebooks + +**Full Changelog**: https://github.com/finitearth/promptolution/commits/0.1.0 From 59ccb8b6f15830834311ef68ad9abf260f23f889 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20Hei=C3=9F?= Date: Sun, 13 Oct 2024 20:15:15 +0200 Subject: [PATCH 2/2] Fix release note links --- docs/release-notes.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index b84126d..99d6bfb 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,7 +6,7 @@ #### Added Features: * Prompt creation utility function * Prompt variation utility function -* New optimizer: OPro (https://arxiv.org/abs/2309.03409) +* New optimizer: OPro (see [arXiv paper](https://arxiv.org/abs/2309.03409)) #### Further Changes: @@ -14,7 +14,7 @@ * New documentation page appearance * Additional Docstrings & Formatting -**Full Changelog**: https://github.com/finitearth/promptolution/compare/v0.1.1...v0.2.0 +**Full Changelog**: [here](https://github.com/finitearth/promptolution/compare/v0.1.1...v0.2.0) ## Release v0.1.1 (2) @@ -30,7 +30,7 @@ * Updated readme * Updated docs -**Full Changelog**: https://github.com/finitearth/promptolution/compare/0.1.1...v0.1.1 +**Full Changelog**: [here](https://github.com/finitearth/promptolution/compare/0.1.1...v0.1.1) ## Release v0.1.1 @@ -44,7 +44,7 @@ * Add documentation pages * Update README -**Full Changelog**: https://github.com/finitearth/promptolution/compare/0.1.0...0.1.1 +**Full Changelog**: [here](https://github.com/finitearth/promptolution/compare/0.1.0...0.1.1) ## Release v0.1.0 @@ -57,12 +57,12 @@ * Classification task * API LLMs from OpenAI, Anthropic, and DeepInfra * Local LLM -* optimizer EvoPrompt GA and EvoPrompt DE (https://arxiv.org/abs/2309.08532) +* optimizer EvoPrompt GA and EvoPrompt DE (see [arXiv paper](https://arxiv.org/abs/2309.08532)) #### Further changes: -* Added example classification datasets used in https://arxiv.org/abs/2309.08532 +* Added example classification datasets used in the [EvoPrompt paper](https://arxiv.org/abs/2309.08532) * Added dummy classes for testing * Added example scripts and configs for experiments * Added experiment results and evaluation notebooks -**Full Changelog**: https://github.com/finitearth/promptolution/commits/0.1.0 +**Full Changelog**: [here](https://github.com/finitearth/promptolution/commits/0.1.0)