Atlas: Competency Based Learning Management System
Welcome to the AtlasML documentation!
What is AtlasML?
AtlasML is a FastAPI-based microservice that provides AI-powered competency management features for the Artemis learning platform. It uses machine learning and vector embeddings to suggest competencies, cluster exercises, and analyze learning relationships—all backed by a centralized Weaviate vector database shared across multiple microservices.
Main Features
- Competency Suggestions - AI-powered competency recommendations for exercises based on semantic similarity
- Exercise Clustering - Automatic grouping of exercises by semantic similarity for course organization
- Vector Embeddings - Azure OpenAI integration for generating multi-modal embeddings
- Centralized Vector Database - Shared Weaviate instance for cross-microservice semantic search
- REST API - FastAPI-based endpoints for integration with Artemis
- Type Safety - Pydantic models for robust data validation and API contracts
Who Should Read This Documentation?
🛠️ Administrators (DevOps/Deployment)
If you need to deploy, configure, or maintain AtlasML in production, start here:
Quick Start Checklist:
- Set up the centralized Weaviate instance (required prerequisite)
- Follow the Installation Guide to deploy AtlasML with Docker Compose
- Configure environment variables using the Configuration Reference
- Review Deployment Best Practices for production setup
- Set up Monitoring to track service health
Key Sections:
- Admin Guide Overview - Introduction to AtlasML administration
- Installation - Docker Compose deployment steps
- Configuration - Complete environment variable reference
- Deployment - Production best practices and CI/CD
- Monitoring - Health checks, logs, and metrics
- Troubleshooting - Common issues and solutions
👨💻 Contributors (Developers)
If you want to contribute code, fix bugs, or understand AtlasML's internals, start here:
Quick Start Checklist:
- Read the Development Process to understand our workflow
- Follow the Setup Guide to get your local environment running
- Review System Design to understand the architecture
- Explore AtlasML Internals for detailed API and data model documentation
Key Sections:
- Development Process - Git workflow, PR process, and contribution guidelines
- System Design - Architecture overview and design decisions
- Setup Guide - Local development environment setup
- Test Guide - Testing practices and running tests
- Code Reference - Detailed code documentation
- AtlasML Internals - API endpoints, models, authentication, and Weaviate integration