# prompt-autotune
A light weight library that takes in a `task description` and a `prompt` and tunes the prompt to perform better.
Accepting any and all PRs!
## Installation
```bash
pip install prompt_autotune
```
## Usage
### Basic usage
1. Import and initialize TunePrompt
```python
from prompt_autotune import TunePrompt
tuner = TunePrompt(
task = "your task here",
prompt = "your prompt here",
verbose = True # makes it log updates
)
```
2. Call it as a function, the tuner will prompt you through the process through the command line
```python
tuner()
```
3. Once finished, access your tuned prompt
```python
new_prompt = tuner.prompt
```
### Command Line Tool
1. Type the command and press enter.
```bash
tune
```
2. Follow through the process.
3. The final prompt will be printed on the console.
Enjoy!
Raw data
{
"_id": null,
"home_page": "https://github.com/ChinmayShrivastava/prompt-autotune",
"name": "prompt-autotune",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Chinmay Shrivastava",
"author_email": "cshrivastava99@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c6/1e/af454cdde424fbf5e904f87ce713d3ddaf55d4dabb8a68422e094783d5be/prompt_autotune-0.3.0.tar.gz",
"platform": null,
"description": "# prompt-autotune\n\n A light weight library that takes in a `task description` and a `prompt` and tunes the prompt to perform better.\n\n Accepting any and all PRs!\n\n## Installation\n\n```bash\npip install prompt_autotune\n```\n\n## Usage\n\n### Basic usage\n\n1. Import and initialize TunePrompt\n\n```python\nfrom prompt_autotune import TunePrompt\ntuner = TunePrompt(\n task = \"your task here\",\n prompt = \"your prompt here\",\n verbose = True # makes it log updates\n)\n```\n\n2. Call it as a function, the tuner will prompt you through the process through the command line\n\n```python\ntuner()\n```\n\n3. Once finished, access your tuned prompt\n\n```python\nnew_prompt = tuner.prompt\n```\n\n### Command Line Tool\n\n1. Type the command and press enter.\n\n```bash\ntune\n```\n\n2. Follow through the process.\n\n\n3. The final prompt will be printed on the console.\n\nEnjoy!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A light weight library that takes in a `task description` and a `prompt` and tunes the prompt to perform better.",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/ChinmayShrivastava/prompt-autotune"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8543b8c29abe2798ae994b40f9c8ba5941d7281b3734863f9b2fce03191d6511",
"md5": "b95f8850dc4eb893aa9338c1e2bb9982",
"sha256": "9532d841115d3ad1a000137971d2cfde438cab2f27f56efcea2a014ab2c07dda"
},
"downloads": -1,
"filename": "prompt_autotune-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b95f8850dc4eb893aa9338c1e2bb9982",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18947,
"upload_time": "2024-03-19T05:59:57",
"upload_time_iso_8601": "2024-03-19T05:59:57.997549Z",
"url": "https://files.pythonhosted.org/packages/85/43/b8c29abe2798ae994b40f9c8ba5941d7281b3734863f9b2fce03191d6511/prompt_autotune-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c61eaf454cdde424fbf5e904f87ce713d3ddaf55d4dabb8a68422e094783d5be",
"md5": "3ac871ca8558faa036c5524f4c3ac34d",
"sha256": "1ecd960841ff468475b48aba2dc2d548ead13ec9c3ea57e23591a2e41a8f976d"
},
"downloads": -1,
"filename": "prompt_autotune-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "3ac871ca8558faa036c5524f4c3ac34d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17204,
"upload_time": "2024-03-19T06:00:00",
"upload_time_iso_8601": "2024-03-19T06:00:00.657768Z",
"url": "https://files.pythonhosted.org/packages/c6/1e/af454cdde424fbf5e904f87ce713d3ddaf55d4dabb8a68422e094783d5be/prompt_autotune-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 06:00:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ChinmayShrivastava",
"github_project": "prompt-autotune",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "prompt-autotune"
}