This directory contains documentation for the ML Systems Evaluation Framework, designed specifically for system engineers working with Industrial AI systems.
📝 Note: This is the documentation index. For the main project overview, installation instructions, and quick start guide, see the main README.md in the project root.
- 🚀 Getting Started: Installation, setup, and first evaluation
- 📦 Installation: Installation and setup instructions
- ⚙️ Configuration: Configuration options, CLI reference, and examples
- 📊 Monitoring: Setting up continuous monitoring
- 🔧 CLI Reference: Command-line interface reference
- 📋 First Evaluation: Running your first evaluation
- 📝 Example Configurations: Ready-to-use configuration examples
- 🏭 Manufacturing: Quality control and predictive maintenance
✈️ Aviation: Safety-critical systems and compliance- ⚡ Energy: Grid optimization and demand prediction
- 🚢 Maritime: Navigation and collision avoidance
- 🛠️ Development: Setup, workflows, and code quality standards
- 🏗️ Architecture: System design, component relationships, and API reference
- 🧪 Testing: Testing strategies and best practices
- 🔌 Extending: How to extend the framework
- 📖 API Reference: Complete API documentation
- ⚙️ Configuration Strategy: Configuration management approach
- 📋 Standards & Compliance: Industry-specific compliance requirements
- 📊 SLO Configuration: Service Level Objectives setup
- 🚨 Error Budgets: Error budget management
- 🚨 Incident Response: Incident handling procedures
- 🤖 LLM Integration: Integrating with Large Language Models
- 📝 Logging Guide: Logging configuration and best practices
- Start with 🚀 Getting Started
- Install the framework with 📦 Installation
- Configure your system with ⚙️ Configuration
- Run your 📋 First Evaluation
- Set up monitoring with 📊 Monitoring
- Review 🏭 Industry Guides for domain-specific best practices
- Configure 📋 Standards & Compliance
- Set up 📊 SLOs and 🚨 Error Budgets
- Read the 🛠️ Development guide
- Understand the 🏗️ Architecture
- Follow 🧪 Testing guidelines
- Learn how to 🔌 Extend the framework
- 🏭 Manufacturing: Manufacturing Guide
✈️ Aviation: Aviation Guide- ⚡ Energy: Energy Guide
- 🚢 Maritime: Maritime Guide
For detailed explanations of key concepts, see the main README.md in the project root.
Systems where failures can result in loss of life, serious injury, or environmental damage.
Systems where failures can result in significant financial loss or operational disruption.
Measurable targets for system reliability, performance, and safety.
The acceptable amount of time a system can be unavailable or not meeting SLOs.
Industry-specific regulations and standards that must be met.
When contributing to documentation:
- 📝 Follow the established structure and format
- 💡 Include practical examples and use cases
- 🏭 Provide industry-specific context where relevant
- 🔄 Keep documentation up-to-date with code changes
- ✍️ Use clear, concise language suitable for system engineers
- 📝 Use clear headings and subheadings
- 💻 Include code examples where appropriate
- 📋 Provide step-by-step instructions for complex procedures
- 🔧 Include troubleshooting sections for common issues
- 📏 Maintain consistency in terminology and formatting