Machine Learning System Design

This repository is dedicated to Machine Learning System Design, featuring end-to-end examples and partially based on this book. While it doesn't offer a comprehensive teaching experience like the book, it provides a structure and a variety of design documents for your use.

Repository Structure

├── templates/                    # Templates and guidelines
│   ├── basic_ml_design_doc.md   # Basic template for ML design docs
│   └── design_doc_checklist.md  # Review checklist for design docs
├── Design_Doc_Examples/         # Example design documents
│   ├── EN/                      # English examples
│   └── [other languages]/       # Examples in other languages
├── BookOutline.md              # Book chapter summaries and key concepts
├── CONTRIBUTING.md             # Contribution guidelines
└── README.md                   # This file

Getting Started

1. New to ML System Design?

   • Start with the BookOutline.md for key concepts
   • Review examples in Design_Doc_Examples/
   • Use templates in templates/ for your own designs

2. Want to Contribute?

   • Read CONTRIBUTING.md for guidelines
   • Use the templates provided
   • Follow the checklist before submitting

3. Looking for Examples?

   • Check Design_Doc_Examples/ for real-world cases
   • Each example follows our standard template
   • Includes different domains and complexity levels

Templates

We provide two main templates:

1. basic_ml_design_doc.md - Standard template for ML system design documents
2. design_doc_checklist.md - Comprehensive review checklist

Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed guidelines. Key areas for contribution:

• New design document examples
• Template improvements
• Best practices documentation
• Code examples
• Reviews and feedback

License

This repository is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Based on concepts from Machine Learning System Design
• Contributors to the examples and templates
• ML community for feedback and improvements