Skip to content

Commit c5989e6

Browse files
Edited section headers in README
1 parent 96e220a commit c5989e6

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -211,14 +211,14 @@ pytest -m "not slow" # Skip slow tests
211211
pytest -m integration # Integration tests only
212212
```
213213

214-
## 📚 Documentation
214+
## Documentation
215215

216216
- **Research Paper**: [ML_Microstructure_Signals_Research_Paper.pdf](ML_Microstructure_Signals_Research_Paper.pdf) - Complete academic paper with results and analysis
217217
- **Paper Sources**: LaTeX source files in `reports/paper/sources/`
218218
- **API Documentation**: Available in `docs/` (generated with Sphinx)
219219
- **Jupyter Notebooks**: Examples in `notebooks/`
220220

221-
## 🤝 Contributing
221+
## Contributing
222222

223223
1. Fork the repository
224224
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
@@ -240,7 +240,7 @@ black --check .
240240
mypy ml_microstructure/
241241
```
242242

243-
## ⚠️ Limitations & Development Challenges
243+
## Limitations & Development Challenges
244244

245245
### Technical Limitations
246246
- **Synthetic data only**: Models tested mainly on generated data, no validation on real high-frequency data
@@ -260,25 +260,25 @@ mypy ml_microstructure/
260260
- No operational risk management
261261
- Manual hyperparameter optimization
262262

263-
## 📄 License
263+
## License
264264

265265
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
266266

267-
## 🙏 Acknowledgments
267+
## Acknowledgments
268268

269269
- **LOBSTER**: High-frequency order book data
270270
- **Kaggle**: Cryptocurrency datasets
271271
- **MLflow**: Experiment tracking
272272
- **Hydra**: Configuration management
273273
- **Streamlit**: Dashboard framework
274274

275-
## 📞 Support
275+
## Support
276276

277277
For questions and support:
278278

279-
- 📧 Email: ismail.moudden1@gmail.com
280-
- 🐛 Issues: [GitHub Issues](https://github.com/IsmailMoudden/ML-Microstructure-Signals/issues)
281-
- 📖 Documentation: [Wiki](https://github.com/IsmailMoudden/ML-Microstructure-Signals/wiki)
279+
- Email: ismail.moudden1@gmail.com
280+
- Issues: [GitHub Issues](https://github.com/IsmailMoudden/ML-Microstructure-Signals/issues)
281+
- Documentation: [Wiki](https://github.com/IsmailMoudden/ML-Microstructure-Signals/wiki)
282282

283283
## Roadmap
284284

@@ -291,7 +291,7 @@ For questions and support:
291291

292292
---
293293

294-
**⚠️ Disclaimer**: This software is for educational and research purposes only. It is not intended for live trading without proper risk management and testing.
294+
**Disclaimer**: This software is for educational and research purposes only. It is not intended for live trading without proper risk management and testing.
295295

296296

297297

0 commit comments

Comments
 (0)