Bill/AI-Trader
1
0
Fork 0
mirror of https://github.com/Xe138/AI-Trader.git synced 2026-04-01 17:17:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: rebrand README.md to AI-Trader-Server

Browse Source 
Phase 1, Task 1 of rebrand implementation:

- Update title from "AI-Trader: Can AI Beat the Market?" to "AI-Trader-Server: REST API for AI Trading"
- Update "What is AI-Trader?" section to "What is AI-Trader-Server?"
- Update all repository URLs from github.com/Xe138/AI-Trader to github.com/Xe138/AI-Trader-Server
- Update Docker image references from ghcr.io/xe138/ai-trader to ghcr.io/xe138/ai-trader-server
- Update Python client class name from AITraderClient to AITraderServerClient
- Update docker exec container name from ai-trader to ai-trader-server
- Add fork acknowledgment section before License, crediting HKUDS/AI-Trader
- Update back-to-top link to reference new title anchor

All changes emphasize REST API service architecture and maintain consistency with new project naming conventions.
This commit is contained in:
Bill Ballou
2025-11-01 11:22:35 -04:00
parent 528b3786b4
commit 6fa2bec043
1 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,6 +1,6 @@
<div align="center"> <div align="center">
# 🚀 AI-Trader: Can AI Beat the Market? # 🚀 AI-Trader-Server: REST API for AI Trading
[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://python.org) [![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://python.org)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) [![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
@@ -15,9 +15,9 @@
--- ---
## 🌟 What is AI-Trader? ## 🌟 What is AI-Trader-Server?
> **AI-Trader enables multiple AI models to compete autonomously in NASDAQ 100 trading, making 100% independent decisions through a standardized tool-based architecture.** > **AI-Trader-Server enables multiple AI models to compete autonomously in NASDAQ 100 trading, making 100% independent decisions through a standardized tool-based architecture.**
### Key Features ### Key Features
@@ -77,8 +77,8 @@
**2. Setup** **2. Setup**
```bash ```bash
git clone https://github.com/Xe138/AI-Trader.git git clone https://github.com/Xe138/AI-Trader-Server.git
cd AI-Trader cd AI-Trader-Server
# Configure environment # Configure environment
cp .env.example .env cp .env.example .env
@@ -193,7 +193,7 @@ Through the MCP (Model Context Protocol) toolchain, AI agents can:
import requests import requests
import time import time
class AITraderClient: class AITraderServerClient:
def __init__(self, base_url="http://localhost:8080"): def __init__(self, base_url="http://localhost:8080"):
self.base_url = base_url self.base_url = base_url
@@ -224,7 +224,7 @@ class AITraderClient:
time.sleep(poll_interval) time.sleep(poll_interval)
# Usage # Usage
client = AITraderClient() client = AITraderServerClient()
job = client.trigger_simulation("2025-01-16", models=["gpt-4"]) job = client.trigger_simulation("2025-01-16", models=["gpt-4"])
result = client.wait_for_completion(job["job_id"]) result = client.wait_for_completion(job["job_id"])
``` ```
@@ -380,7 +380,7 @@ SQLite database at `data/jobs.db` contains:
Query directly: Query directly:
```bash ```bash
docker exec -it ai-trader sqlite3 /app/data/jobs.db docker exec -it ai-trader-server sqlite3 /app/data/jobs.db
sqlite> SELECT * FROM jobs ORDER BY created_at DESC LIMIT 5; sqlite> SELECT * FROM jobs ORDER BY created_at DESC LIMIT 5;
``` ```
@@ -444,6 +444,12 @@ Contributions welcome! Please read [docs/developer/CONTRIBUTING.md](docs/develop
--- ---
## 🙏 Acknowledgments
This project is a fork of [HKUDS/AI-Trader](https://github.com/HKUDS/AI-Trader), re-architected as a REST API service for external orchestration and integration.
---
## 📄 License ## 📄 License
MIT License - see [LICENSE](LICENSE) for details MIT License - see [LICENSE](LICENSE) for details
@@ -452,9 +458,9 @@ MIT License - see [LICENSE](LICENSE) for details
## 🔗 Links ## 🔗 Links
- **GitHub**: https://github.com/Xe138/AI-Trader - **GitHub**: https://github.com/Xe138/AI-Trader-Server
- **Docker Hub**: `ghcr.io/xe138/ai-trader:latest` - **Docker Hub**: `ghcr.io/xe138/ai-trader-server:latest`
- **Issues**: https://github.com/Xe138/AI-Trader/issues - **Issues**: https://github.com/Xe138/AI-Trader-Server/issues
- **API Docs**: http://localhost:8080/docs (when running) - **API Docs**: http://localhost:8080/docs (when running)
--- ---
@@ -463,6 +469,6 @@ MIT License - see [LICENSE](LICENSE) for details
**Built with FastAPI, SQLite, Docker, and the MCP Protocol** **Built with FastAPI, SQLite, Docker, and the MCP Protocol**
[⬆ Back to top](#-ai-trader-can-ai-beat-the-market) [⬆ Back to top](#-ai-trader-server-rest-api-for-ai-trading)
</div> </div>