Skip to content

Commit c3662b1

Browse files
committed
add doc, fix some bug
1 parent 537158d commit c3662b1

File tree

4 files changed

+102
-4
lines changed

4 files changed

+102
-4
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# GAIA Validation - GPT5
2+
3+
MiroFlow now supports GPT-5 with MCP tool invocation, providing a unified workflow for multi-step reasoning, information integration, and scalable tool coordination.
4+
5+
!!! info "Prerequisites"
6+
Before proceeding, please review the [GAIA Validation Prerequisites](gaia_validation_prerequisites.md) document, which covers common setup requirements, dataset preparation, and API key configuration.
7+
8+
---
9+
10+
## Running the Evaluation
11+
12+
### Step 1: Dataset Preparation
13+
14+
Follow the [dataset preparation instructions](gaia_validation_prerequisites.md#dataset-preparation) in the prerequisites document.
15+
16+
### Step 2: API Keys Configuration
17+
18+
Configure the following API keys in your `.env` file:
19+
20+
```env title="GPT-5 .env Configuration"
21+
# Search and web scraping capabilities
22+
SERPER_API_KEY="your-serper-api-key"
23+
JINA_API_KEY="your-jina-api-key"
24+
25+
# Code execution environment
26+
E2B_API_KEY="your-e2b-api-key"
27+
28+
# Vision understanding capabilities
29+
ANTHROPIC_API_KEY="your-anthropic-api-key"
30+
GEMINI_API_KEY="your-gemini-api-key"
31+
32+
# Primary LLM provider, LLM judge, reasoning, and hint generation
33+
OPENAI_API_KEY="your-openai-api-key"
34+
OPENAI_BASE_URL="https://api.openai.com/v1"
35+
36+
```
37+
38+
### Step 3: Run the Evaluation
39+
40+
Execute the evaluation using the GPT-5 configuration:
41+
42+
```bash title="Run GAIA Validation with GPT-5"
43+
uv run main.py common-benchmark \
44+
--config_file_name=agent_gaia-validation-gpt5 \
45+
output_dir="logs/gaia-validation-gpt5/$(date +"%Y%m%d_%H%M")"
46+
```
47+
48+
### Step 4: Monitor Progress
49+
50+
Follow the [progress monitoring instructions](gaia_validation_prerequisites.md#progress-monitoring-and-resume) in the prerequisites document.
51+
52+
53+
---
54+
55+
!!! info "Documentation Info"
56+
**Last Updated:** October 2025 · **Doc Contributor:** Team @ MiroMind AI

docs/mkdocs/docs/llm_clients_overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ MiroFlow supports multiple LLM providers through a unified client interface. Eac
99
| `ClaudeAnthropicClient` | Anthropic Direct | claude-3-7-sonnet | `ANTHROPIC_API_KEY`, `ANTHROPIC_BASE_URL` |
1010
| `ClaudeOpenRouterClient` | OpenRouter | anthropic/claude-3.7-sonnet, and other [supported models](https://openrouter.ai/models) | `OPENROUTER_API_KEY`, `OPENROUTER_BASE_URL` |
1111
| `GPTOpenAIClient` | OpenAI | gpt-4, gpt-3.5 | `OPENAI_API_KEY`, `OPENAI_BASE_URL` |
12+
| `GPT5OpenAIClient` | OpenAI | gpt-5 | `OPENAI_API_KEY`, `OPENAI_BASE_URL` |
1213
| `MiroThinkerSGLangClient` | SGLang | MiroThinker series | `OAI_MIROTHINKER_API_KEY`, `OAI_MIROTHINKER_BASE_URL` |
1314

1415
## Basic Configuration
@@ -31,4 +32,4 @@ main_agent:
3132
---
3233

3334
!!! info "Documentation Info"
34-
**Last Updated:** September 2025 · **Doc Contributor:** Team @ MiroMind AI
35+
**Last Updated:** October 2025 · **Doc Contributor:** Team @ MiroMind AI

docs/mkdocs/docs/openai-gpt.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,45 @@
11
# OpenAI GPT Models
22

3-
OpenAI's latest models including GPT-4o and advanced reasoning models with strong coding, vision, and reasoning capabilities.
3+
OpenAI's latest models including GPT-5, GPT-4o and advanced reasoning models with strong coding, vision, and reasoning capabilities.
44

5-
## Client Used
5+
## Client Used for GPT-5
6+
7+
`GPT5OpenAIClient`
8+
9+
## Environment Setup
10+
11+
```bash title="Environment Variables"
12+
export OPENAI_API_KEY="your-openai-key"
13+
export OPENAI_BASE_URL="https://api.openai.com/v1" # optional
14+
```
15+
16+
## Configuration
17+
18+
```yaml title="Agent Configuration"
19+
main_agent:
20+
llm:
21+
provider_class: "GPT5OpenAIClient"
22+
model_name: "gpt-5"
23+
async_client: true
24+
temperature: 1.0
25+
top_p: 1.0
26+
min_p: 0.0
27+
top_k: -1
28+
max_tokens: 128000
29+
reasoning_effort: "high" # Use high in the main agent, and use the default medium in the sub-agent.
30+
openai_api_key: "${oc.env:OPENAI_API_KEY,???}"
31+
openai_base_url: "${oc.env:OPENAI_BASE_URL,https://api.openai.com/v1}"
32+
```
33+
34+
## Usage
35+
36+
```bash title="Example Command"
37+
# Create custom OpenAI config
38+
uv run main.py trace --config_file_name=your_config_file \
39+
--task="Your task" --task_file_name="data/file.txt"
40+
```
41+
42+
## Client Used for GPT-4o
643

744
`GPTOpenAIClient`
845

@@ -32,7 +69,10 @@ uv run main.py trace --config_file_name=your_config_file \
3269
--task="Your task" --task_file_name="data/file.txt"
3370
```
3471

72+
!!! note "Configuration Notes"
73+
- `GPTOpenAIClient` also supports GPT-5, but it has not been fully validated on MiroFlow yet. We recommend using `GPT5OpenAIClient`.
74+
3575
---
3676

3777
!!! info "Documentation Info"
38-
**Last Updated:** September 2025 · **Doc Contributor:** Team @ MiroMind AI
78+
**Last Updated:** October 2025 · **Doc Contributor:** Team @ MiroMind AI

docs/mkdocs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ nav:
5252
- GAIA-Validation:
5353
- Prerequisites: gaia_validation_prerequisites.md
5454
- Claude-3.7-Sonnet: gaia_validation_claude37sonnet.md
55+
- GPT-5: gaia_validation_gpt5.md
5556
- MiroThinker: gaia_validation_mirothinker.md
5657
- GAIA-Validation-Text-Only: gaia_validation_text_only.md
5758
- GAIA-Test: gaia_test.md

0 commit comments

Comments
 (0)