diff --git a/TEMP_RELEASE.txt b/TEMP_RELEASE.txt deleted file mode 100644 index 1c927b6f..00000000 --- a/TEMP_RELEASE.txt +++ /dev/null @@ -1,327 +0,0 @@ -# GitHub Release v1.0.0 - Komplette Vorlage - -## Release Title (Titel): -``` -v1.0.0 - Initial Release: EURUSD Trading Agent -``` - ---- - -## Release Body (Markdown) - KOMPLETT: - -```markdown -## πŸŽ‰ Predix v1.0.0 - Initial Release - -### πŸ“Š What is Predix? - -**Predix** is an autonomous AI-powered quantitative trading agent for EUR/USD forex markets. It automates the full research and development cycle for trading strategies: - -- πŸ“Š **Data Analysis** – Automatically analyzes market patterns and microstructure -- πŸ’‘ **Strategy Discovery** – Proposes novel trading factors and signals -- 🧠 **Model Evolution** – Iteratively improves predictive models -- πŸ“ˆ **Backtesting** – Validates strategies on historical 1-minute data - ---- - -### ✨ Key Features - -#### Autonomous Factor Generation -- **110+ EURUSD factors** generated autonomously using LLMs -- Multi-agent debate system (Bull/Bear/Neutral analysts) -- Stanley Druckenmiller-style macro analysis -- Market regime detection using Hurst Exponent - -#### Comprehensive Backtesting -- **Backtesting engine** with IC, Sharpe Ratio, Max Drawdown metrics -- SQLite database for tracking all backtest results -- Correlation analysis and portfolio optimization -- Risk management with position limits and leverage controls - -#### Professional Testing -- **97 unit tests** with **98.77% code coverage** -- Edge case testing for all metrics -- Integration tests for full workflows - -#### Dashboards & UI -- **Web Dashboard** (Flask + HTML) - Live trading progress -- **CLI Dashboard** (Rich library) - Terminal-based UI -- Real-time macro data (EURUSD, DXY, Volatility) -- Session-aware analysis (Asian/London/NY sessions) - -#### Developer Experience -- All code comments in English -- Comprehensive documentation (QWEN.md, README.md) -- Clean git history with English commit messages -- Proper attribution guidelines (ATTRIBUTION.md) - ---- - -### πŸ—οΈ Technical Stack - -- **Python 3.10/3.11** - Primary language -- **PyTorch** - Deep learning models -- **Qlib** - Backtesting engine -- **LLM (Qwen3.5-35B)** - Factor generation via local llama.cpp -- **Flask** - Web dashboard API -- **SQLite** - Results database -- **Rich/Typer** - CLI interface -- **pytest** - Testing framework (98.77% coverage) - ---- - -### πŸ“ Project Structure - -``` -Predix/ -β”œβ”€β”€ rdagent/ # Core agent framework -β”‚ β”œβ”€β”€ components/ -β”‚ β”‚ β”œβ”€β”€ backtesting/ # Backtest engine, metrics, database -β”‚ β”‚ └── coder/ -β”‚ β”‚ └── factor_coder/ # Factor generation & EURUSD modules -β”‚ └── scenarios/ -β”‚ └── qlib/ # Qlib integration for FX trading -β”œβ”€β”€ test/ # Unit tests (97 tests, 98.77% coverage) -β”œβ”€β”€ web/ # Dashboard frontend -β”œβ”€β”€ results/ # Backtest results (not in git) -β”œβ”€β”€ docs/ # Documentation -└── requirements.txt # Dependencies -``` - ---- - -### πŸš€ Quick Start - -#### Installation - -```bash -# Clone repository -git clone https://github.com/TPTBusiness/Predix.git -cd Predix - -# Create conda environment -conda create -n predix python=3.10 -conda activate predix - -# Install in editable mode -pip install -e .[test,lint] -``` - -#### Configuration - -```bash -# Create .env file -cat << EOF > .env -CHAT_MODEL=qwen3.5-35b -OPENAI_API_BASE=http://localhost:8081/v1 -OPENAI_API_KEY=local -EMBEDDING_MODEL=nomic-embed-text -QLIB_DATA_DIR=~/.qlib/qlib_data/eurusd_1min_data -EOF - -# Start LLM server (llama.cpp) -~/llama.cpp/build/bin/llama-server \ - --model ~/models/qwen3.5/Qwen3.5-35B-A3B-Q3_K_M.gguf \ - --n-gpu-layers 36 \ - --ctx-size 80000 \ - --port 8081 -``` - -#### Run Trading Loop - -```bash -# Start trading loop (24/7) -./start_loop.sh - -# Or single run with dashboard -python predix.py fin_quant --with-dashboard -``` - ---- - -### πŸ“Š Performance Metrics - -| Metric | Target | Status | -|--------|--------|--------| -| **Test Coverage** | >80% | βœ… **98.77%** | -| **Tests Passed** | All | βœ… **97/97** | -| **Factors Generated** | 100+ | βœ… **110+** | -| **Code Quality** | Clean | βœ… **All English** | -| **Documentation** | Complete | βœ… **QWEN.md, README** | - ---- - -### πŸ“ License & Attribution - -**License:** MIT License - -**Attribution Requirements:** - -If you use this code or concepts in your project, you **must**: -1. Include the MIT License text -2. Keep the copyright notice: "Copyright (c) 2025 Predix Team" -3. Provide attribution to the original project - -See [ATTRIBUTION.md](ATTRIBUTION.md) for detailed guidelines and examples. - -**Legal Basis:** MIT License requires: -> "The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software." - ---- - -### πŸ™ Acknowledgments - -This project draws inspiration from various open-source projects: - -- **[Microsoft RD-Agent](https://github.com/microsoft/RD-Agent)** (MIT License) - Foundation for our autonomous R&D agent framework -- **[TradingAgents](https://github.com/TradingAgents/TradingAgents)** (Apache 2.0 License) - Inspiration for multi-agent debate system -- **[ai-hedge-fund](https://github.com/virattt/ai-hedge-fund)** - Inspiration for macro analysis and risk management concepts - -**All code in Predix is originally written and implemented independently.** - ---- - -### πŸ“¦ Installation Options - -#### Full Installation (with dev dependencies) -```bash -pip install -e .[test,lint,docs] -``` - -#### Minimal Installation -```bash -pip install -e . -``` - -#### Docker (Coming Soon) -```bash -docker pull predixai/predix:latest -docker run -it predixai/predix -``` - ---- - -### πŸ§ͺ Testing - -```bash -# Run all tests -pytest test/ -v - -# Run with coverage -pytest test/ --cov=rdagent --cov-report=html - -# Run specific test suite -pytest test/backtesting/ -v -``` - ---- - -### πŸ“š Documentation - -- **README.md** - Installation and quick start -- **QWEN.md** - Comprehensive development guide -- **ATTRIBUTION.md** - Usage guidelines and attribution requirements -- **CHANGELOG.md** - Version history overview -- **changelog/v1.0.0.md** - Detailed v1.0.0 release notes -- **docs/** - Additional documentation - ---- - -### πŸ”§ Development - -```bash -# Linting -ruff check rdagent/ - -# Type checking -mypy rdagent/ - -# Format code -black rdagent/ - -# Run tests -pytest test/backtesting/ -v -``` - ---- - -### πŸ“ž Support - -- **Issues**: [GitHub Issues](https://github.com/TPTBusiness/Predix/issues) -- **Discussions**: [GitHub Discussions](https://github.com/TPTBusiness/Predix/discussions) - ---- - -### ⚠️ Disclaimer - -**This project is for educational and research purposes only.** - -- Not intended for real trading or investment -- No investment advice or guarantees provided -- Creator assumes no liability for financial losses -- Consult a financial advisor for investment decisions -- Past performance does not indicate future results - -By using this software, you agree to use it solely for learning purposes. - ---- - -### 🎯 What's Next? - -**Planned for v1.1.0:** -- [ ] Live paper-trading integration -- [ ] Additional factor types (ML-based) -- [ ] Performance optimization -- [ ] Docker containerization -- [ ] CI/CD pipeline - ---- - -### πŸ“ˆ Statistics - -- **Lines of Code:** ~15,000+ -- **Files:** 100+ -- **Commits:** 20+ -- **Contributors:** 1 -- **Stars:** ⭐ (Be the first to star!) - ---- - -**Full changelog:** [v1.0.0 Release Notes](https://github.com/TPTBusiness/Predix/blob/v1.0.0/changelog/v1.0.0.md) - ---- - -
- -**If you like this project, please ⭐ star this repository!** - -Made with ❀️ by Predix Team - -
-``` - ---- - -## Tags (SchlagwΓΆrter fΓΌr Repository Topics): -``` -eurusd, trading, ai, machine-learning, quantitative-trading, forex, backtesting, llm, rd-agent, python, mit-license -``` - ---- - -## Checkliste vor dem VerΓΆffentlichen: - -- [ ] Release Title kopiert: `v1.0.0 - Initial Release: EURUSD Trading Agent` -- [ ] Release Body (Markdown oben) komplett kopiert -- [ ] Repository Topics auf GitHub gesetzt (unter Settings β†’ Topics) -- [ ] "Set as latest release" angehakt -- [ ] Publish Release geklickt - ---- - -## Optional: Assets hochladen - -Falls du Screenshots oder Binaries hochladen willst: -- [ ] Screenshot vom Dashboard -- [ ] Screenshot von Test-Ergebnissen (98.77% Coverage) -- [ ] PDF mit Dokumentation -- [ ] Andere relevante Dateien diff --git a/TODO.md b/TODO.md index 61b1e6f2..476dbdae 100644 --- a/TODO.md +++ b/TODO.md @@ -4,13 +4,42 @@ This file tracks global TODOs for the Predix project. Individual TODOs in code s ## Current Global TODOs +### Low Priority (Post-v1.0.0) + - [ ] Align naming conventions for files in `components/` and `scenarios/` directories - Current mismatch: `coder` in `components/` vs `developer` in `scenarios/` + - **Status:** Inherited from RD-Agent upstream, works as-is + - **Priority:** Low - cosmetic only, no functional impact + - [ ] Clean up folder naming inconsistencies - Investigate why some scenario-related code is in `experiments/` folders + - **Status:** Historical structure from RD-Agent + - **Priority:** Low - works correctly, can refactor later ## Completed +### v1.0.0 Release (2026-04-02) + - [x] Rebrand from RD-Agent to Predix for EUR/USD focus - [x] Remove Microsoft-specific references - [x] Update documentation for PredixAI organization +- [x] Translate all code comments to English +- [x] Create comprehensive QWEN.md (development guide) +- [x] Create ATTRIBUTION.md (usage guidelines) +- [x] Update README.md with installation and quick start +- [x] Create CHANGELOG.md with v1.0.0 release notes +- [x] Create changelog/ directory structure (changelog/v1.0.0.md) +- [x] Prepare GitHub Release v1.0.0 +- [x] Pass all tests (97/97, 98.77% coverage) +- [x] Complete .gitignore for sensitive files +- [x] Clean up git history (remove logs, test artifacts) +- [x] Add English-only commit message policy to QWEN.md +- [x] Add comprehensive Acknowledgments (RD-Agent, TradingAgents, ai-hedge-fund) + +### Future Releases + +- [ ] v1.1.0: Live paper-trading integration +- [ ] v1.1.0: Additional ML-based factor types +- [ ] v1.2.0: Docker containerization +- [ ] v1.2.0: CI/CD pipeline +- [ ] v1.3.0: Performance optimization