Update README.md

This commit is contained in:
pliny
2023-11-03 19:18:32 -07:00
committed by GitHub
parent bc74492269
commit 4560af663e

View File

@@ -2,6 +2,7 @@
AutoTemp is a Python tool that enhances language model interactions by intelligently selecting the optimal temperature setting for generating responses. It leverages multiple temperature settings to produce a variety of outputs and then evaluates these outputs to determine which temperature yields the best result for a given prompt. AutoTemp is a Python tool that enhances language model interactions by intelligently selecting the optimal temperature setting for generating responses. It leverages multiple temperature settings to produce a variety of outputs and then evaluates these outputs to determine which temperature yields the best result for a given prompt.
## Features ## Features
- **Multi-Temperature Evaluation**: Tests multiple temperature settings to find the best output for a given prompt. - **Multi-Temperature Evaluation**: Tests multiple temperature settings to find the best output for a given prompt.
@@ -10,6 +11,7 @@ AutoTemp is a Python tool that enhances language model interactions by intellige
- **Customizable Temperature Range**: Users can define a custom range of temperatures to be tested for each prompt. - **Customizable Temperature Range**: Users can define a custom range of temperatures to be tested for each prompt.
- **Easy Integration**: Designed to work with OpenAI's GPT-3.5 or GPT-4 and is compatible with other language models that support temperature settings. - **Easy Integration**: Designed to work with OpenAI's GPT-3.5 or GPT-4 and is compatible with other language models that support temperature settings.
## Installation ## Installation
To install AutoTemp, you can simply clone the repository and install the required dependencies. To install AutoTemp, you can simply clone the repository and install the required dependencies.
@@ -18,6 +20,7 @@ git clone https://github.com/elder-plinius/AutoTemp.git
cd AutoTemp cd AutoTemp
pip install -r requirements.txt pip install -r requirements.txt
## OpenAI API Key ## OpenAI API Key
Before running AutoTemp, you need to set up your API key in an .env file at the root of the project: Before running AutoTemp, you need to set up your API key in an .env file at the root of the project:
@@ -26,13 +29,19 @@ OPENAI_API_KEY='your-api-key-here'
This file should not be committed to your version control system as it contains sensitive information. This file should not be committed to your version control system as it contains sensitive information.
## Usage ## Usage
To use AutoTemp, simply run the `autotemp.py` script with Python and follow the prompts (saying "no" you are not satisfied will trigger autotemp): To use AutoTemp, simply run the `autotemp.py` script with Python and follow the prompts (saying "no" you are not satisfied will trigger AutoTemp to optimize your output):
python autotemp.py python autotemp.py
Enter your prompt in line 81:
prompt = "YOUR-PROMPT-HERE"
## Configuration ## Configuration
You can customize the behavior of AutoTemp by setting the following parameters when initializing AutoTempAgent: You can customize the behavior of AutoTemp by setting the following parameters when initializing AutoTempAgent: