GitHub-Proxy/deer-flow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/bytedance/deer-flow synced 2025-08-18 00:25:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add notes

Browse Source
This commit is contained in:
Li Xin 2025-05-08 10:02:19 +08:00
parent 0298907e39
commit 2e2fe19c75
4 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.env.example
View File

@ -12,3 +12,6 @@ VOLCENGINE_TTS_APPID=xxx
VOLCENGINE_TTS_ACCESS_TOKEN=xxx VOLCENGINE_TTS_ACCESS_TOKEN=xxx
# VOLCENGINE_TTS_CLUSTER=volcano_tts # Optional, default is volcano_tts # VOLCENGINE_TTS_CLUSTER=volcano_tts # Optional, default is volcano_tts
# VOLCENGINE_TTS_VOICE_TYPE=BV700_V2_streaming # Optional, default is BV700_V2_streaming # VOLCENGINE_TTS_VOICE_TYPE=BV700_V2_streaming # Optional, default is BV700_V2_streaming
# [!NOTE]
# For model settings and other configurations, please refer to `docs/configuration_guide.md`

2
README.md
View File

@ -92,7 +92,7 @@ brew install marp-cli
Optionally, install web UI dependencies via [pnpm](https://pnpm.io/installation): Optionally, install web UI dependencies via [pnpm](https://pnpm.io/installation):
```bash ```bash
cd web cd deer-flow/web
pnpm install pnpm install
``` ```

1
conf.yaml.example
View File

@ -1,3 +1,4 @@
# [!NOTE]
# Read the `docs/configuration_guide.md` carefully, and update the configurations to match your specific settings and requirements. # Read the `docs/configuration_guide.md` carefully, and update the configurations to match your specific settings and requirements.
# - Replace `api_key` with your own credentials # - Replace `api_key` with your own credentials
# - Replace `base_url` and `model` name if you want to use a custom model # - Replace `base_url` and `model` name if you want to use a custom model

9
docs/configuration_guide.md
View File

@ -1,5 +1,14 @@
# Configuration Guide # Configuration Guide
## Quick Settings
Copy the `conf.yaml.example` file to `conf.yaml` and modify the configurations to match your specific settings and requirements.
```bash
cd deer-flow
cp conf.yaml.example conf.yaml
```
## Which models does DeerFlow support? ## Which models does DeerFlow support?
In DeerFlow, currently we only support non-reasoning models, which means models like OpenAI's o1/o3 or DeepSeek's R1 are not supported yet, but we will add support for them in the future. In DeerFlow, currently we only support non-reasoning models, which means models like OpenAI's o1/o3 or DeepSeek's R1 are not supported yet, but we will add support for them in the future.