Skip to main content

Kai Documentation

Welcome to the Kai documentation. This index provides links to all documentation files organized by category.

Project Overview​

  • Main Project Overview - Complete introduction to the Kai system
  • Folder Structure - Organization and component interactions
  • Analytics System - Analytics architecture and predictive capabilities

ML Components​

Machine Learning Core​

  • ML Package - Overview of ML functionality for material recognition
  • ML Python Modules - Python implementation of ML components
  • OCR Enhancements - Text extraction improvements
  • Training API Improvements - Enhanced training capabilities

Model Context Protocol​

  • MCP Client - TypeScript client for the MCP server
  • MCP Server - Centralized model management service
  • MCP Server Guide - Detailed implementation guide

Material Recognition​

  • Material Recognition - ML-powered material identification
  • PDF Processing Pipeline - Processing PDFs for material data
  • PDF Processing - Catalog extraction capabilities
  • OCR - Optical Character Recognition system

Data Management​

  • Knowledge Base - Material storage and retrieval system
  • Datasets and Models - Integration of premade datasets with AI models

Metadata​

  • Material Metadata Fields - Specifications for material metadata
  • Material Metadata Extraction - Extraction system for metadata

Infrastructure & Development​

Infrastructure​

  • Queue System - Message broker and async processing
  • Web Crawling - Web content extraction for materials
  • Testing Approach - Testing strategy and best practices
  • Kubernetes Architecture - Kubernetes implementation details
  • HPA Configuration Guide - Horizontal Pod Autoscaling configuration
  • Advanced Scaling Features - Predictive scaling and cross-service dependencies
  • Monitoring System - System health monitoring and operational visibility

Deployment​

  • Deployment & Development - Environment setup guide
  • Deployment Guide - Production deployment instructions
  • Digital Ocean Kubernetes Setup - DO-specific deployment
  • Vercel Deployment Guide - Vercel-specific deployment

Database & Storage​

  • Database & Vector DB - Database architecture
  • Supabase - Supabase integration overview
  • Supabase Setup Guide - Detailed Supabase setup

User Interfaces​

  • Admin Panel - Administration interface
  • HeroUI Integration - UI component system implementation
  • MoodBoard Feature - Material collection and organization feature

API & Integration​

  • API Reference - Comprehensive API endpoints
  • Implementation Plans - Roadmap for future features

Quality & Metrics​

  • Quality of Data and Metrics - Data quality standards

Additional Documentation​

Additional documentation can be found in the following locations:

  • Package-specific documentation (moved to this central location)
  • Code comments for implementation details
  • API documentation generated from code

Documentation Tools​

  • Documentation Consolidation - Automated system for generating consolidated DOCX documentation