Skip to content

Commit ffa3ff0

Browse files
committed
Simplify README: Keep only essential Azure OpenAI example
1 parent 8397ef6 commit ffa3ff0

1 file changed

Lines changed: 6 additions & 37 deletions

File tree

README.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,14 @@
44
55
## 🚀 Azure OpenAI Support
66

7-
AutoEvolve now supports **Azure OpenAI** with automatic detection. Simply configure your Azure endpoint in the config file and the system will automatically use the `AzureOpenAI` client.
8-
9-
### Quick Setup for Azure OpenAI
10-
11-
Add the following to your `config.yaml`:
7+
AutoEvolve supports **Azure OpenAI** with automatic detection. Use this exact config format:
128

139
```yaml
1410
# LLM configuration
1511
llm:
1612
primary_model: "gpt-5" # Your Azure deployment name
17-
api_base: "https://YOUR_RESOURCE.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT?api-version=2024-12-01-preview"
18-
api_key: "YOUR_AZURE_API_KEY" # Set your API key here or use OPENAI_API_KEY env var
13+
api_base: "https://east-docetl.openai.azure.com/openai/deployments/gpt-4.1?api-version=2024-12-01-preview"
14+
api_key: "YOUR_API_KEY_HERE" # Replace with your Azure API key
1915
primary_model_weight: 1.0
2016
temperature: 0.7
2117
top_p: 0.95
@@ -24,39 +20,12 @@ llm:
2420

2521
# Database configuration
2622
database:
27-
# ... other settings ...
28-
29-
# Paradigm Breakthrough (for stagnation handling)
3023
enable_paradigm_breakthrough: true
3124
stagnation_window: 5
3225
stagnation_improvement_threshold: 0.01
33-
paradigm_model: "gpt-5-mini" # Your Azure deployment name for paradigm generation
34-
paradigm_api_base: "https://YOUR_RESOURCE.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT?api-version=2024-12-01-preview"
35-
paradigm_api_key: "YOUR_AZURE_API_KEY" # Set your API key here or use OPENAI_API_KEY env var
36-
```
37-
38-
### Important Notes
39-
40-
- **Deployment Name**: The `primary_model` and `paradigm_model` should match your Azure deployment names (e.g., `gpt-5`, `gpt-4.1`, `gpt-5-mini`)
41-
- **API Base URL Format**: Must include the full path: `https://YOUR_RESOURCE.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT?api-version=2024-12-01-preview`
42-
- **API Version**: Use `2024-12-01-preview` (or your Azure API version)
43-
- **Automatic Detection**: The system automatically detects Azure endpoints (`.openai.azure.com`) and uses the `AzureOpenAI` client
44-
- **Reasoning Models**: Supports reasoning models like `gpt-5`, `gpt-5-mini` - automatically uses `max_completion_tokens` instead of `max_tokens`
45-
- **API Key**: You can set it in the config file or use the `OPENAI_API_KEY` environment variable
46-
47-
### Example: Complete Azure Configuration
48-
49-
```yaml
50-
llm:
51-
primary_model: "gpt-5"
52-
api_base: "https://east-docetl.openai.azure.com/openai/deployments/gpt-4.1?api-version=2024-12-01-preview"
53-
api_key: "YOUR_API_KEY_HERE" # Replace with your actual Azure API key
54-
55-
database:
56-
enable_paradigm_breakthrough: true
57-
paradigm_model: "gpt-5-mini"
26+
paradigm_model: "gpt-5-mini" # Your Azure deployment name
5827
paradigm_api_base: "https://east-docetl.openai.azure.com/openai/deployments/gpt-4.1?api-version=2024-12-01-preview"
59-
paradigm_api_key: "YOUR_API_KEY_HERE" # Replace with your actual Azure API key
28+
paradigm_api_key: "YOUR_API_KEY_HERE" # Replace with your Azure API key
6029
```
6130
62-
**That's it!** Just replace `YOUR_API_KEY_HERE` with your actual Azure API key and everything will work automatically.
31+
**Just replace `YOUR_API_KEY_HERE` with your actual Azure API key and it will work.**

0 commit comments

Comments
 (0)