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

Files changed (1) hide show
  1. README.md +93 -0
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