2933046060
� Important Clarification - DashScope API Key Requirements: � Updated Documentation: - docs/en-US/quick_start_guide.md - docs/en-US/configuration_guide.md - .env.example � DashScope API Key is ONLY required when: 1. � Analyzing Chinese A-share stocks (uses TongDaXin data + DashScope embeddings) 2. � Choosing DashScope as LLM provider (Qwen models) ✅ For US Stock Analysis: - OpenAI + FinnHub: ✅ No DashScope needed - Google AI + FinnHub: ✅ No DashScope needed - Anthropic + FinnHub: ✅ No DashScope needed ✅ DashScope Required Cases: - China A-Share + Any LLM: ✅ DashScope needed (for embeddings) - US Stock + DashScope LLM: ✅ DashScope needed (for Qwen models) - China A-Share + DashScope LLM: ✅ DashScope needed (both reasons) � Updated Configuration Examples: - Example 1: US stocks with OpenAI (no DashScope) - Example 2: US stocks with Google AI (no DashScope) - Example 3: China A-shares (DashScope required) - Example 4: US stocks with DashScope LLM (DashScope required) - Example 5: Full features with database � Key Benefits: - Users can start with familiar LLM providers (OpenAI/Google) - DashScope only needed for Chinese market features - Clear separation of requirements by use case - Reduced barrier to entry for US-only users This clarification makes it easier for users to understand exactly when they need which API keys based on their specific use case and market focus. |
||
|---|---|---|
| .. | ||
| en-US | ||
| README.md | ||
README.md
TradingAgents Documentation
📚 Documentation Structure
This documentation is organized into language-specific directories to serve different user communities:
🇺🇸 English Documentation (en-US/)
Status: ✅ Included in version control
Contains comprehensive guides for English-speaking users:
- Configuration Guide (
configuration_guide.md) - Detailed instructions for modifying system configurations and agent prompts - Quick Reference (
quick_reference.md) - Quick lookup card for common modifications and file locations - Prompt Templates (
prompt_templates.md) - Ready-to-use prompt templates for various agent roles
🇨🇳 Chinese Documentation (zh-CN/)
Status: 🚫 Excluded from version control (local development only)
Contains detailed guides in Chinese for local development and customization:
- 配置指南 (
configuration_guide.md) - 详细的配置修改和提示词定制指南 - 快速参考 (
quick_reference.md) - 新手友好的快速查找卡片 - 提示词模板库 (
prompt_templates.md) - 可直接使用的提示词模板
🎯 Quick Start
For English Users
Navigate to en-US/ directory for:
- System configuration instructions
- Prompt customization guides
- Template libraries
- Troubleshooting tips
For Chinese Users
Navigate to zh-CN/ directory (local development) for:
- 系统配置说明
- 提示词定制指南
- 模板库
- 故障排除技巧
📖 Available Guides
| Guide | English | Chinese | Description |
|---|---|---|---|
| Configuration Guide | 📖 View | 📖 View (Local) | Complete guide for modifying configurations and prompts |
| Quick Reference | 🚀 View | 🚀 View (Local) | Quick lookup for common modifications |
| Prompt Templates | 🎯 View | 🎯 View (Local) | Ready-to-use prompt templates |
🔧 Key Topics Covered
Configuration Management
- LLM provider settings (DashScope, OpenAI, Google, Anthropic)
- DashScope (Alibaba Cloud): Full support for Qwen model series ⭐ Recommended for Chinese users
- Current Setup: DashScope as primary option with intelligent fallback
- Market selection and data sources
- US Stock Market: Yahoo Finance integration
- China A-Share Market: TongDaXin API integration ⭐ New Feature
- Database and caching systems
- MongoDB: Persistent data storage
- Redis: High-performance caching
- Intelligent Cache: Automatic fallback mechanisms
- Debate and discussion parameters
- API configuration and limits
Agent Customization
- Market Analyst prompts
- Fundamentals Analyst prompts
- News and Social Media Analyst prompts
- Bull/Bear Researcher prompts
- Trader decision prompts
- Reflection system prompts
Advanced Features
- Multi-market support: US stocks and China A-shares
- Database integration: MongoDB and Redis for enterprise deployment
- Intelligent caching: Adaptive cache management with fallback
- Multi-LLM support: DashScope, OpenAI, Google, Anthropic
- TongDaXin integration: Real-time A-share data access
- Risk management templates
- Performance optimization
- Custom prompt creation
- Environment-specific configurations
🚀 Getting Started
- Choose Your Language: Select the appropriate documentation directory
- Start with Quick Reference: Get familiar with key file locations
- Read Configuration Guide: Understand the system architecture
- Use Prompt Templates: Copy and customize templates for your needs
- Test Changes: Always test modifications in a safe environment
🛠️ Development Workflow
For Contributors
-
English Documentation:
- Modify files in
en-US/directory - Commit changes to version control
- These will be available to all users
- Modify files in
-
Chinese Documentation:
- Modify files in
zh-CN/directory - Keep changes local (not committed)
- Use for local development and testing
- Modify files in
Version Control Policy
- ✅ Include:
en-US/directory and all English documentation - 🚫 Exclude:
zh-CN/directory (configured in.gitignore) - ✅ Include: This README file for navigation
📝 Contributing
When contributing to documentation:
- Update English docs for features that should be shared with the community
- Keep Chinese docs local for development and customization purposes
- Maintain consistency between language versions when possible
- Test all examples before documenting them
🔗 Related Resources
- Project Repository: Main TradingAgents codebase
- Configuration Files:
tradingagents/default_config.py,main.py - Agent Files:
tradingagents/agents/directory - Test Files:
tests/directory (local only)
📞 Support
For questions about:
- Configuration: See Configuration Guide
- Prompts: See Prompt Templates
- Quick Help: See Quick Reference
- Issues: Submit to project repository
💡 Note: This documentation structure allows for both community sharing (English) and local customization (Chinese) while maintaining clean version control.