Fix/naming and docs #47

finitearth · 2025-05-17T17:50:24Z

No description provided.

* chore: add codeowners file * chore: add python poetry action and docs workflow * chore: update pre-commit file * chore: update docs * chore: update logo * chore: add cicd pipeline for automated deployment * chore: update poetry version * chore: fix action versioning * chore: add gitattributes to ignore line count in jupyter notebooks * chore: add and update docstrings * chore: fix end of files * chore: update action versions * Update README.md --------- Co-authored-by: mo374z <schlager.mo@t-online.de>

* chore: fix workflow execution * chore: fix version check in CICD pipeline

* update gitignore * initial implementation of opro * formatting of prompt template * added opro test run * opro refinements * fixed sampling error * add docs to opro * fix pre commit issues# * fix pre commit issues# * fixed end of line

* fixed pre commit config and removed end of file line breaks in tempaltes * added /

* added prompt_creation.py * change version

* Remove deepinfra file * change langchain-community version

* renamed get_tasks to get_task and change functionality accordingly. moved templates and data_sets * init * move templates to templates.py * Add nested asyncio to make it useable in notebooks * Update README.md * changed getting_started.ipynb and created helper functions * added sampling of initial population * fixed config * fixed callbacks * adjust runs * fix run evaluation api token * fix naming convention in opro, remove on epoch end for logger callback, fixed to allow for numeric values in class names * Update promptolution/llms/api_llm.py Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com> * fixed comments * Update pyproject.toml * resolve comments --------- Co-authored-by: mo374z <schlager.mo@t-online.de> Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com> Co-authored-by: Moritz Schlager <87517800+mo374z@users.noreply.github.com>

* implemented random selector * added random search selector * increased version count * fix typos * Update promptolution/predictors/base_predictor.py Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com> * Update promptolution/tasks/classification_tasks.py Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com> * resolve comments * resolve comments --------- Co-authored-by: Timo Heiß <87521684+timo282@users.noreply.github.com>

* Update release-notes.md * Fix release note links

This reverts commit e23dd74.

* Delete Experiment files * Removed config necessities * improved opro meta-prompts * added read from data frame feature * changed required python version to 3.9

…o dev

* delete poetry.lock and upgrade transformers dependency * Update release-notes.md

github-actions · 2025-05-19T11:35:33Z

Tests	Skipped	Failures	Errors	Time
63	0 💤	0 ❌	0 🔥	1.000s ⏱️

…romptolution into fix/naming_and_docs

Copilot

Pull Request Overview

This PR updates naming conventions and documentation details to improve consistency and clarity across the codebase. Key changes include renaming parameters in the API module (e.g. changing "llm" to "model_id" and "token" to "api_key"), moving and updating ExperimentConfig references, and adjusting documentation and notebook examples to reflect these updates.

Reviewed Changes

Copilot reviewed 66 out of 66 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
promptolution/llms/api_llm.py	Renamed parameters and updated logger usage with get_logger
promptolution/llms/init.py	Updated imports, removing unused factory functions
promptolution/helpers.py	Refactored type annotations and adjusted evaluation strategy checks
promptolution/exemplar_selectors/*.py	Updated type hints for clarity
notebooks/getting_started.ipynb	Updated API key parameter names and revised import paths
docs/**	Adjusted release notes and API documentation to reflect new config paths
README.md	Updated project description and optimizer table format
.pre-commit-config.yaml	Modified exclusion regex pattern

Comments suppressed due to low confidence (2)

promptolution/llms/api_llm.py:68

Renaming the parameter from 'llm' to 'model_id' improves clarity; please ensure that all calls to this parameter across the codebase are updated accordingly.

model_id: str = None,

.pre-commit-config.yaml:2

Please verify that the updated exclusion regex pattern effectively excludes the intended files for pre-commit hooks.

-exclude: '^(?!(promptolution/|tests/)).*$|^promptolution/templates.py'

promptolution/helpers.py

…romptolution into fix/naming_and_docs

README.md

notebooks/getting_started.ipynb

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

…romptolution into fix/naming_and_docs

timo282 and others added 30 commits October 3, 2024 23:02

Fix/workflows (#11)

1f0119f

* chore: fix workflow execution * chore: fix version check in CICD pipeline

Opro implementation (#7)

ba39fd6

* update gitignore * initial implementation of opro * formatting of prompt template * added opro test run * opro refinements * fixed sampling error * add docs to opro * fix pre commit issues# * fix pre commit issues# * fixed end of line

Patch/pre commit config (#10)

37591b7

* fixed pre commit config and removed end of file line breaks in tempaltes * added /

Feature/prompt generation (#12)

5e2c0a9

* added prompt_creation.py * change version

Create LICENSE (#14)

689701a

Refactor/remove deepinfra (#16)

f69bbb2

* Remove deepinfra file * change langchain-community version

Chore/docs release notes (#18)

e23dd74

* Update release-notes.md * Fix release note links

Merge branch dev accepting all incoming changes

25639c9

revert Chore/docs release notes (#18)"

2ac359b

This reverts commit e23dd74.

revert last commit

3e650cc

updated release notes and read me

3f4c757

Feature/read from df (#21)

ac2af13

* Delete Experiment files * Removed config necessities * improved opro meta-prompts * added read from data frame feature * changed required python version to 3.9

Update pyproject.toml

7987f99

Update release-notes.md

7217011

merge

2727b6e

merge

87fd54c

Merge branch 'dev' of https://github.com/finitearth/promptolution int…

aa6b7d7

…o dev

merges

6e69b58

resolve merge mistakes

e935fa2

delete duplicated lines

68c67f3

Update release-notes.md (#24)

bee6d8d

Fix/dependencies (#28)

3ca7893

* delete poetry.lock and upgrade transformers dependency * Update release-notes.md

Merge branch 'main' into dev

d6203d6

Add vllm as feature and a llm_test_run_script

683d926

small fixes in vllm class

69837fa

differentiate between vllm and api inference

7563712

set up experiment over multiple tasks and prompts

af6f9f8

finitearth added 3 commits May 19, 2025 12:50

fix helpers

05be7c7

fix demo scripts

ec23db8

formatting

0804892

finitearth and others added 4 commits May 19, 2025 11:35

Update coverage badge in README [skip ci]

06361a4

fix tests

440519b

Merge branch 'fix/naming_and_docs' of https://github.com/finitearth/p…

d440cd1

…romptolution into fix/naming_and_docs

Update coverage badge in README [skip ci]

2e9d602

finitearth requested review from Copilot and mo374z May 19, 2025 12:13

Copilot AI reviewed May 19, 2025

View reviewed changes

promptolution/helpers.py Show resolved Hide resolved

finitearth and others added 6 commits May 19, 2025 14:15

remove convergence speed from read me

9922d76

rename Opro to OPRO

934b6a1

Merge branch 'fix/naming_and_docs' of https://github.com/finitearth/p…

d5cd78f

…romptolution into fix/naming_and_docs

changed imports in isort

26e720d

Update API reference in docs

f9c50dd

Merge branch 'fix/naming_and_docs' of https://github.com/finitearth/p…

1309c33

…romptolution into fix/naming_and_docs

timo282 approved these changes May 19, 2025

View reviewed changes

finitearth and others added 9 commits May 19, 2025 15:48

Update README.md

d64acf4

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

Update README.md

66bff5e

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

Update README.md

d07c5e6

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

Update README.md

61a0810

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

Update README.md

e7a926f

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

Update README.md

d1f4946

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

fixed task description in notebook

6128f82

Merge branch 'fix/naming_and_docs' of https://github.com/finitearth/p…

9d809fa

…romptolution into fix/naming_and_docs

Update v2.0.0.md

72ab156

mo374z approved these changes May 19, 2025

View reviewed changes

mo374z merged commit 3cf3d13 into main May 19, 2025
2 checks passed

mo374z deleted the fix/naming_and_docs branch May 19, 2025 20:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix/naming and docs #47

Fix/naming and docs #47

Uh oh!

finitearth commented May 17, 2025

Uh oh!

github-actions bot commented May 19, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fix/naming and docs #47

Fix/naming and docs #47

Uh oh!

Conversation

finitearth commented May 17, 2025

Uh oh!

github-actions bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented May 19, 2025 •

edited

Loading