Skip to content

Commit c5b8c1b

Browse files
Update README.md
1 parent 19bda7c commit c5b8c1b

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

README.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -135,23 +135,45 @@ print("Geomagnetic Storm Prediction: Ready for deployment")
135135

136136
## 📁 **PROJECT STRUCTURE**
137137

138-
SOLARIS-X/
139-
├── 📊 data/
140-
│ └── processed/features/ # Engineered datasets (excluded)
141-
├── 🤖 scripts/
142-
│ ├── preprocessing/ # Data processing pipeline
143-
│ └── training/ # ML model training
144-
│ ├── models/ # Individual model trainers
145-
│ ├── utils/ # Training utilities
146-
│ └── complete_pipeline.py # Main training orchestrator
147-
├── 💾 models/
148-
│ ├── trained/ # Production models (excluded)
149-
│ └── checkpoints/ # Training checkpoints (excluded)
150-
├── 📈 results/
151-
│ └── plots/ # Performance visualizations
152-
├── 📋 requirements.txt # Python dependencies
153-
├── 🔧 .gitignore # Git exclusion rules
154-
└── 📖 README.md # This file
138+
### **Core Directories**
139+
140+
**📊 Data Pipeline**
141+
- `data/processed/features/` - Engineered feature datasets (excluded)
142+
- `data/raw/omni/` - Original OMNI database files (excluded)
143+
144+
**🤖 Training System**
145+
- `scripts/training/models/` - Individual model trainers (4 advanced models)
146+
- `scripts/training/utils/` - Training utilities and base classes
147+
- `scripts/training/complete_pipeline.py` - Main orchestrator
148+
149+
**💾 Model Management**
150+
- `models/checkpoints/` - Training checkpoints and metadata
151+
- `models/trained/` - Production models (excluded)
152+
153+
**📈 Results & Analysis**
154+
- `results/plots/` - Performance visualizations (10 charts)
155+
156+
**📋 Configuration**
157+
- `requirements.txt` - Python dependencies
158+
- `.gitignore` - Repository optimization
159+
- `README.md` - Documentation
160+
161+
### **Key Features**
162+
- **25+ Python modules** with professional architecture
163+
- **4 advanced ML models** including meta-ensemble system
164+
- **Complete MLOps pipeline** with automated evaluation
165+
- **Production-ready deployment** configuration
166+
167+
---
168+
### **🏗️ Architecture Highlights**
169+
- **Modular Design**: Separated model trainers and utilities
170+
- **Production Ready**: Complete MLOps pipeline structure
171+
- **Optimized Storage**: Large files excluded via .gitignore
172+
- **Comprehensive Evaluation**: Visualization and metrics tracking
173+
- **Professional Organization**: Clear separation of concerns
174+
175+
**Note**: Files marked as "(excluded)" are not tracked in git due to size constraints but are generated during training.
176+
155177

156178

157179
---
@@ -254,3 +276,4 @@ This project is licensed under the **MIT License**.
254276

255277
</div>
256278

279+

0 commit comments

Comments
 (0)