Skip to content

Commit a61f919

Browse files
finitearthfinitearth
committed
docs
1 parent bcecca6 commit a61f919

File tree

14 files changed

+183
-7
lines changed

14 files changed

+183
-7
lines changed

‎README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Create API Keys for the models you want to use:
2121
- Anthropic: store token in anthropictoken.txt
2222
- DeepInfra (for Llama): store token in deepinfratoken.txt
2323

24-
TODO: CREATE WHEEL FILES AND UPLOAD TO PIP
25-
2624
Run experiments based on config via:
2725

2826
```

‎docs/api/callbacks.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Callbacks
2+
3+
This module contains callback implementations for various purposes.
4+
5+
::: promptolution.callbacks
6+
options:
7+
show_submodules: true

‎docs/api/config.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Config
2+
3+
This module contains the configuration settings for the Promptolution library.
4+
5+
::: promptolution.config.Config
6+
options:
7+
show_root_heading: true
8+
show_root_full_path: false
9+
show_if_no_docstring: true

‎docs/api/llms.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# LLMs
2+
3+
This module contains the LLM (Large Language Model) implementations.
4+
5+
::: promptolution.llms
6+
options:
7+
show_submodules: true
8+
9+
## API LLM
10+
11+
::: promptolution.llms.api_llm
12+
13+
## Base LLM
14+
15+
::: promptolution.llms.base_llm
16+
17+
## DeepInfra LLM
18+
19+
::: promptolution.llms.deepinfra
20+
21+
## Local LLM
22+
23+
::: promptolution.llms.local_llm

‎docs/api/optimizers.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Optimizers
2+
3+
This module contains various optimization algorithms for prompt tuning.
4+
5+
::: promptolution.optimizers
6+
options:
7+
show_submodules: true
8+
9+
## Base Optimizer
10+
11+
::: promptolution.optimizers.base_optimizer
12+
13+
## EvoPrompt DE
14+
15+
::: promptolution.optimizers.evoprompt_de
16+
17+
## EvoPrompt GA
18+
19+
::: promptolution.optimizers.evoprompt_ga

‎docs/api/predictors.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Predictors
2+
3+
This module contains predictor implementations for various tasks.
4+
5+
::: promptolution.predictors
6+
options:
7+
show_submodules: true
8+
9+
## Base Predictor
10+
11+
::: promptolution.predictors.base_predictor
12+
13+
## Classifier
14+
15+
::: promptolution.predictors.classificator

‎docs/api/tasks.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Tasks
2+
3+
This module contains task-specific implementations.
4+
5+
::: promptolution.tasks
6+
options:
7+
show_submodules: true
8+
9+
## Base Task
10+
11+
::: promptolution.tasks.base_task
12+
13+
## Classification Tasks
14+
15+
::: promptolution.tasks.classification_tasks

‎docs/index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Welcome to Promptolution
2+
3+
Promptolution is a library for optimizing prompts for large language models.
4+
5+
## Features
6+
7+
- Various LLM implementations
8+
- Optimization algorithms for prompt tuning
9+
- Task-specific modules
10+
- Flexible configuration options
11+
12+
## Getting Started
13+
14+
To get started with Promptolution, check out our API reference for detailed information on each module.
15+
16+
## API Reference
17+
18+
- [LLMs](api/llms.md)
19+
- [Optimizers](api/optimizers.md)
20+
- [Predictors](api/predictors.md)
21+
- [Tasks](api/tasks.md)
22+
- [Callbacks](api/callbacks.md)
23+
- [Config](api/config.md)

‎mkdocs.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
site_name: Promptolution Documentation
2+
theme:
3+
name: mkdocs
4+
features:
5+
- navigation.tabs
6+
- navigation.sections
7+
- toc.integrate
8+
- search.suggest
9+
- search.highlight
10+
- content.tabs.link
11+
- content.code.annotation
12+
- content.code.copy
13+
language: en
14+
palette:
15+
- scheme: default
16+
toggle:
17+
icon: material/toggle-switch-off-outline
18+
name: Switch to dark mode
19+
primary: teal
20+
accent: purple
21+
- scheme: slate
22+
toggle:
23+
icon: material/toggle-switch
24+
name: Switch to light mode
25+
primary: teal
26+
accent: lime
27+
28+
plugins:
29+
- search
30+
- mkdocstrings:
31+
default_handler: python
32+
handlers:
33+
python:
34+
rendering:
35+
show_source: true
36+
watch:
37+
- promptolution
38+
39+
nav:
40+
- Home: index.md
41+
- API Reference:
42+
- LLMs: api/llms.md
43+
- Optimizers: api/optimizers.md
44+
- Predictors: api/predictors.md
45+
- Tasks: api/tasks.md
46+
- Callbacks: api/callbacks.md
47+
- Config: api/config.md
48+
49+
markdown_extensions:
50+
- pymdownx.highlight:
51+
anchor_linenums: true
52+
- pymdownx.inlinehilite
53+
- pymdownx.snippets
54+
- admonition
55+
- pymdownx.arithmatex:
56+
generic: true
57+
- footnotes
58+
- pymdownx.details
59+
- pymdownx.superfences
60+
- pymdownx.mark
61+
- attr_list
62+
63+
copyright: |
64+
&copy; 2024 <a href="https://github.com/yourusername" target="_blank" rel="noopener">Tom Zehle, Timo Heiß, Moritz Schlager</a>

‎promptolution/__init__.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
from . import llms
2+
from . import optimizers
3+
from . import predictors
4+
from . import tasks
5+
from . import callbacks
6+
from . import config

0 commit comments

Comments
 (0)