Edwin Salguero
commited on
Commit
Β·
81c8995
1
Parent(s):
5d0a64a
docs: Add comprehensive project directory structure to README
Browse files- Add detailed directory tree with emojis and descriptions
- Include architecture overview with core components
- Document key features and development workflow
- Show complete project organization for new contributors
README.md
CHANGED
@@ -256,6 +256,99 @@ result = agent.predict(
|
|
256 |
5. **Order Execution**: Real-time order placement through Alpaca
|
257 |
6. **Performance Tracking**: Continuous monitoring and logging
|
258 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
259 |
## π§ Configuration
|
260 |
|
261 |
### Alpaca Settings
|
|
|
256 |
5. **Order Execution**: Real-time order placement through Alpaca
|
257 |
6. **Performance Tracking**: Continuous monitoring and logging
|
258 |
|
259 |
+
## π Project Directory Structure
|
260 |
+
|
261 |
+
```
|
262 |
+
algorithmic_trading/
|
263 |
+
βββ π README.md # Project documentation
|
264 |
+
βββ π LICENSE # Alpaca 2 License
|
265 |
+
βββ π requirements.txt # Python dependencies
|
266 |
+
βββ π config.yaml # Main configuration file
|
267 |
+
βββ π env.example # Environment variables template
|
268 |
+
βββ π .gitignore # Git ignore rules
|
269 |
+
βββ π pytest.ini # Test configuration
|
270 |
+
β
|
271 |
+
βββ π³ Docker/
|
272 |
+
β βββ π Dockerfile # Container definition
|
273 |
+
β βββ π docker-entrypoint.sh # Container startup script
|
274 |
+
β βββ π .dockerignore # Docker ignore rules
|
275 |
+
β βββ π docker-compose.yml # Default compose file
|
276 |
+
β βββ π docker-compose.dev.yml # Development environment
|
277 |
+
β βββ π docker-compose.prod.yml # Production environment
|
278 |
+
β βββ π docker-compose.hub.yml # Docker Hub deployment
|
279 |
+
β
|
280 |
+
βββ π€ agentic_ai_system/ # Core AI trading system
|
281 |
+
β βββ π main.py # Main entry point
|
282 |
+
β βββ π orchestrator.py # System coordination
|
283 |
+
β βββ π agent_base.py # Base agent class
|
284 |
+
β βββ π data_ingestion.py # Market data processing
|
285 |
+
β βββ π strategy_agent.py # Trading strategy logic
|
286 |
+
β βββ π execution_agent.py # Order execution
|
287 |
+
β βββ π finrl_agent.py # FinRL reinforcement learning
|
288 |
+
β βββ π alpaca_broker.py # Alpaca API integration
|
289 |
+
β βββ π synthetic_data_generator.py # Test data generation
|
290 |
+
β βββ π logger_config.py # Logging configuration
|
291 |
+
β
|
292 |
+
βββ π§ͺ tests/ # Test suite
|
293 |
+
β βββ π __init__.py
|
294 |
+
β βββ π test_data_ingestion.py
|
295 |
+
β βββ π test_strategy_agent.py
|
296 |
+
β βββ π test_execution_agent.py
|
297 |
+
β βββ π test_finrl_agent.py
|
298 |
+
β βββ π test_synthetic_data_generator.py
|
299 |
+
β βββ π test_integration.py
|
300 |
+
β
|
301 |
+
βββ π data/ # Market data storage
|
302 |
+
β βββ π synthetic_market_data.csv
|
303 |
+
β
|
304 |
+
βββ π§ models/ # Trained AI models
|
305 |
+
β βββ π finrl_best/ # Best FinRL models
|
306 |
+
β
|
307 |
+
βββ π plots/ # Generated charts/visualizations
|
308 |
+
β
|
309 |
+
βββ π logs/ # System logs
|
310 |
+
β βββ π trading_system.log
|
311 |
+
β βββ π trading.log
|
312 |
+
β βββ π performance.log
|
313 |
+
β βββ π errors.log
|
314 |
+
β βββ π finrl_tensorboard/ # FinRL training logs
|
315 |
+
β βββ π finrl_eval/ # Model evaluation logs
|
316 |
+
β
|
317 |
+
βββ π§ scripts/ # Utility scripts
|
318 |
+
β βββ π docker-build.sh # Docker build automation
|
319 |
+
β βββ π docker-hub-deploy.sh # Docker Hub deployment
|
320 |
+
β
|
321 |
+
βββ π demo.py # Main demo script
|
322 |
+
βββ π finrl_demo.py # FinRL-specific demo
|
323 |
+
βββ π DOCKER_HUB_SETUP.md # Docker Hub documentation
|
324 |
+
β
|
325 |
+
βββ π .venv/ # Python virtual environment
|
326 |
+
```
|
327 |
+
|
328 |
+
### ποΈ Architecture Overview
|
329 |
+
|
330 |
+
#### **Core Components:**
|
331 |
+
- **Data Layer**: Market data ingestion and preprocessing
|
332 |
+
- **Strategy Layer**: Technical analysis and signal generation
|
333 |
+
- **AI Layer**: FinRL reinforcement learning agents
|
334 |
+
- **Execution Layer**: Order management and broker integration
|
335 |
+
- **Orchestration**: System coordination and workflow management
|
336 |
+
|
337 |
+
#### **Key Features:**
|
338 |
+
- **Modular Design**: Each component is independent and testable
|
339 |
+
- **Docker Support**: Complete containerization for deployment
|
340 |
+
- **Testing**: Comprehensive test suite for all components
|
341 |
+
- **Logging**: Detailed logging for monitoring and debugging
|
342 |
+
- **Configuration**: Centralized configuration management
|
343 |
+
- **Documentation**: Extensive documentation and examples
|
344 |
+
|
345 |
+
#### **Development Workflow:**
|
346 |
+
1. **Data Ingestion** β Market data from Alpaca/CSV/synthetic sources
|
347 |
+
2. **Strategy Generation** β Technical indicators and FinRL predictions
|
348 |
+
3. **Risk Management** β Position sizing and portfolio protection
|
349 |
+
4. **Order Execution** β Real-time trading through Alpaca
|
350 |
+
5. **Performance Tracking** β Continuous monitoring and logging
|
351 |
+
|
352 |
## π§ Configuration
|
353 |
|
354 |
### Alpaca Settings
|