ai-accelerator 0.1.0__py3-none-any.whl

ai_accelerator-0.1.0.dist-info/METADATA

@@ -0,0 +1,1079 @@
+Metadata-Version: 2.4
+Name: ai-accelerator
+Version: 0.1.0
+Summary: AI Accelerator Platform - Deploy, monitor, and govern machine learning models in production
+License: Apache License
+        Version 2.0, January 2004
+        http://www.apache.org/licenses/
+        
+        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+        1. Definitions.
+        
+        "License" shall mean the terms and conditions for use, reproduction,
+        and distribution as defined by Sections 1 through 9 of this document.
+        
+        "Licensor" shall mean the copyright owner or entity granting the License.
+        
+        "Legal Entity" shall mean the union of the acting entity and all
+        other entities that control, are controlled by, or are under common
+        control with that entity. For the purposes of this definition,
+        "control" means (i) the power, direct or indirect, to cause the
+        direction or management of such entity, whether by contract or
+        otherwise, or (ii) ownership of fifty percent (50%) or more of the
+        outstanding shares, or (iii) beneficial ownership of such entity.
+        
+        "You" (or "Your") shall mean an individual or Legal Entity
+        exercising permissions granted by this License.
+        
+        "Source" form shall mean the preferred form for making modifications,
+        including but not limited to software source code, documentation
+        source, and configuration files.
+        
+        "Object" form shall mean any form resulting from mechanical
+        transformation or translation of a Source form, including but
+        not limited to compiled object code, generated documentation,
+        and conversions to other media types.
+        
+        "Work" shall mean the work of authorship, whether in Source or
+        Object form, made available under the License, as indicated by a
+        copyright notice that is included in or attached to the work
+        (an example is provided in the Appendix below).
+        
+        "Derivative Works" shall mean any work, whether in Source or Object
+        form, that is based upon (or derived from) the Work and for which the
+        editorial revisions, annotations, elaborations, or other modifications
+        represent, as a whole, an original work of authorship. For the purposes
+        of this License, Derivative Works shall not include works that remain
+        separable from, or merely link (or bind by name) to the interfaces of,
+        the Work and derivative works thereof.
+        
+        "Contribution" shall mean any work of authorship, including
+        the original version of the Work and any modifications or additions
+        to that Work or Derivative Works thereof, that is intentionally
+        submitted to Licensor for inclusion in the Work by the copyright owner
+        or by an individual or Legal Entity authorized to submit on behalf of
+        the copyright owner. For the purposes of this definition, "submitted"
+        means any form of electronic, verbal, or written communication sent
+        to the Licensor or its representatives, including but not limited to
+        communication on electronic mailing lists, source code control systems,
+        and issue tracking systems that are managed by, or on behalf of, the
+        Licensor for the purpose of discussing and improving the Work, but
+        excluding communication that is conspicuously marked or otherwise
+        designated in writing by the copyright owner as "Not a Contribution."
+        
+        "Contributor" shall mean Licensor and any individual or Legal Entity
+        on behalf of whom a Contribution has been received by Licensor and
+        subsequently incorporated within the Work.
+        
+        2. Grant of Copyright License. Subject to the terms and conditions of
+        this License, each Contributor hereby grants to You a perpetual,
+        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+        copyright license to use, reproduce, prepare Derivative Works of,
+        publicly display, publicly perform, sublicense, and distribute the
+        Work and such Derivative Works in Source or Object form.
+        
+        3. Grant of Patent License. Subject to the terms and conditions of
+        this License, each Contributor hereby grants to You a perpetual,
+        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+        (except as stated in this section) patent license to make, have made,
+        use, offer to sell, sell, import, and otherwise transfer the Work,
+        where such license applies only to those patent claims licensable
+        by such Contributor that are necessarily infringed by their
+        Contribution(s) alone or by combination of their Contribution(s)
+        with the Work to which such Contribution(s) was submitted. If You
+        institute patent litigation against any entity (including a
+        cross-claim or counterclaim in a lawsuit) alleging that the Work
+        or a Contribution incorporated within the Work constitutes direct
+        or contributory patent infringement, then any patent licenses
+        granted to You under this License for that Work shall terminate
+        as of the date such litigation is filed.
+        
+        4. Redistribution. You may reproduce and distribute copies of the
+        Work or Derivative Works thereof in any medium, with or without
+        modifications, and in Source or Object form, provided that You
+        meet the following conditions:
+        
+        (a) You must give any other recipients of the Work or
+        Derivative Works a copy of this License; and
+        
+        (b) You must cause any modified files to carry prominent notices
+        stating that You changed the files; and
+        
+        (c) You must retain, in the Source form of any Derivative Works
+        that You distribute, all copyright, trademark, patent,
+        attribution and other notices from the Source form of the Work,
+        excluding those notices that do not pertain to any part of
+        the Derivative Works; and
+        
+        (d) If the Work includes a "NOTICE" file as part of its
+        distribution, then any Derivative Works that You distribute must
+        include a readable copy of the attribution notices contained
+        within such NOTICE file, excluding those notices that do not
+        pertain to any part of the Derivative Works, in at least one
+        of the following places: within a NOTICE file distributed
+        as part of the Derivative Works; within the Source form or
+        documentation, if provided along with the Derivative Works; or,
+        within a display generated by the Derivative Works, if and
+        wherever such third-party notices normally appear. The contents
+        of the NOTICE file are for informational purposes only and
+        do not modify the License. You may add Your own attribution
+        notices within Derivative Works that You distribute, alongside
+        or as an addendum to the NOTICE text from the Work, provided
+        that such additional attribution notices cannot be construed
+        as modifying the License.
+        
+        You may add Your own copyright notice to Your modifications and
+        may provide additional or different license terms and conditions
+        for use, reproduction, or distribution of Your modifications, or
+        for any such Derivative Works as a whole, provided Your use,
+        reproduction, and distribution of the Work otherwise complies with
+        the conditions stated in this License.
+        
+        5. Submission of Contributions. Unless You explicitly state otherwise,
+        any Contribution intentionally submitted for inclusion in the Work
+        by You to the Licensor shall be under the terms and conditions of
+        this License, without any additional terms or conditions.
+        Notwithstanding the above, nothing herein shall supersede or modify
+        the terms of any separate license agreement you may have executed
+        with Licensor regarding such Contributions.
+        
+        6. Trademarks. This License does not grant permission to use the trade
+        names, trademarks, service marks, or product names of the Licensor,
+        except as required for reasonable and customary use in describing the
+        origin of the Work and reproducing the content of the NOTICE file.
+        
+        7. Disclaimer of Warranty. Unless required by applicable law or
+        agreed to in writing, Licensor provides the Work (and each
+        Contributor provides its Contributions) on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+        implied, including, without limitation, any warranties or conditions
+        of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+        PARTICULAR PURPOSE. You are solely responsible for determining the
+        appropriateness of using or redistributing the Work and assume any
+        risks associated with Your exercise of permissions under this License.
+        
+        8. Limitation of Liability. In no event and under no legal theory,
+        whether in tort (including negligence), contract, or otherwise,
+        unless required by applicable law (such as deliberate and grossly
+        negligent acts) or agreed to in writing, shall any Contributor be
+        liable to You for damages, including any direct, indirect, special,
+        incidental, or consequential damages of any character arising as a
+        result of this License or out of the use or inability to use the
+        Work (including but not limited to damages for loss of goodwill,
+        work stoppage, computer failure or malfunction, or any and all
+        other commercial damages or losses), even if such Contributor
+        has been advised of the possibility of such damages.
+        
+        9. Accepting Support, Warranty or Additional Liability. While redistributing
+        the Work or Derivative Works thereof, You may choose to offer,
+        and charge a fee for, acceptance of support, warranty, indemnity,
+        or other liability obligations and/or rights consistent with this
+        License. However, in accepting such obligations, You may act only
+        on Your own behalf and on Your sole responsibility, not on behalf
+        of any other Contributor, and only if You agree to indemnify,
+        defend, and hold each Contributor harmless for any liability
+        incurred by, or claims asserted against, such Contributor by reason
+        of your accepting any such warranty or additional liability.
+        
+        END OF TERMS AND CONDITIONS
+        
+        APPENDIX: How to apply the Apache License to your work.
+        
+        To apply the Apache License to your work, attach the following
+        boilerplate notice, with the fields enclosed by brackets "[]"
+        replaced with your own identifying information. (Don't include
+        the brackets!)  The text should be enclosed in the appropriate
+        comment syntax for the file format. We also recommend that a
+        file or class name and description of purpose be included on the
+        same "page" as the copyright notice for easier identification within
+        third-party archives.
+        
+        Copyright 2026 AI Accelerator Team
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+        http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+Project-URL: Homepage, https://github.com/AyoubArdem/ai-accelerator
+Project-URL: Repository, https://github.com/AyoubArdem/ai-accelerator
+Project-URL: Issues, https://github.com/AyoubArdem/ai-accelerator/issues
+Project-URL: Documentation, https://ai-accelerator.readthedocs.io/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=5.2.8
+Requires-Dist: djangorestframework>=3.14.0
+Requires-Dist: drf-spectacular>=0.26.5
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: celery>=5.3.4
+Requires-Dist: redis>=5.0.1
+Requires-Dist: docker>=7.0.0
+Requires-Dist: numpy>=1.24.3
+Requires-Dist: scipy>=1.11.4
+Requires-Dist: psycopg2-binary>=2.9.9
+Requires-Dist: python-decouple>=3.8
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.3; extra == "dev"
+Requires-Dist: pytest-django>=4.5.2; extra == "dev"
+Requires-Dist: black>=23.12.1; extra == "dev"
+Requires-Dist: flake8>=6.1.0; extra == "dev"
+Requires-Dist: isort>=5.13.2; extra == "dev"
+Requires-Dist: pre-commit>=3.6.0; extra == "dev"
+Dynamic: license-file
+
+
+# 🚀 AI Accelerator Platform
+
+**AI Accelerator** is an end-to-end platform designed to **deploy, monitor, and govern machine learning models in production** in a secure, scalable, and auditable way.
+
+[![PyPI version](https://badge.fury.io/py/ai-accelerator.svg)](https://pypi.org/project/ai-accelerator/)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
+
+The project aims to be a **core MLOps foundation** for companies, ML teams, and developers who want to move from experimental notebooks to **real production-grade AI systems**.
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install ai-accelerator
+```
+
+### From Source
+
+```bash
+git clone https://github.com/AyoubArdem/ai-accelerator.git
+cd ai-accelerator
+pip install -e .
+```
+
+### Development Setup
+
+For contributors and development:
+
+```bash
+git clone https://github.com/AyoubArdem/ai-accelerator.git
+cd ai-accelerator
+
+# Create virtual environment
+python -m venv env1
+source env1/bin/activate  # On Windows: env1\Scripts\activate
+
+# Install in development mode
+pip install -e .
+pip install -e ".[dev]"  # Development dependencies
+
+# Run migrations
+python manage.py migrate
+
+# Create superuser
+python manage.py createsuperuser
+```
+
+## 🚀 Quick Start
+
+### 1. Start the Platform
+
+```bash
+# Start Django development server
+python manage.py runserver
+
+# Server will be available at: http://127.0.0.1:8000
+```
+
+### 2. Access API Documentation
+
+Visit the interactive API documentation:
+- **Swagger UI**: http://127.0.0.1:8000/api/schema/swagger-ui/
+- **ReDoc**: http://127.0.0.1:8000/api/schema/redoc/
+
+### 3. Use the CLI
+
+```bash
+# Check CLI help
+aiac --help
+```
+
+## 📚 Documentation & Resources
+
+| Document | Description |
+|----------|-------------|
+| [**README.md**](README.md) | Project overview, setup, and usage guide |
+| [**CONSOLE.md**](CONSOLE.md) | Detailed AIAC CLI usage instructions |
+| [**CONTRIBUTING.md**](CONTRIBUTING.md) | Guidelines for contributing to the project |
+| [**CHANGELOG.md**](CHANGELOG.md) | Version history and release notes |
+| [**SECURITY.md**](SECURITY.md) | Security policy and vulnerability reporting |
+| [**CODE_OF_CONDUCT.md**](CODE_OF_CONDUCT.md) | Community standards and behavior guidelines |
+| [**LICENSE**](LICENSE) | Apache 2.0 License terms |
+
+
+
+## 🎯 Project Vision & Goals
+
+Modern AI teams face critical challenges:
+
+* ❌ Manual and inconsistent model deployment
+* ❌ Lack of monitoring after deployment
+* ❌ No detection of **data drift / model drift**
+* ❌ Missing governance and policy enforcement
+* ❌ Poor auditability and traceability
+* ❌ Over-reliance on complex UIs instead of DevOps tools
+
+✅ **AI Accelerator** addresses these challenges by providing:
+
+* Automated model deployment
+* Continuous monitoring & drift detection
+* Governance and policy-based control
+* Security-first architecture
+* A powerful CLI for engineers
+
+---
+
+## 🧱 High-Level Architecture
+
+```
+                ┌─────────────┐
+                │     CLI     │  ← aiac
+                └──────┬──────┘
+                       │
+                ┌──────▼──────┐
+                │   Django    │
+                │   Backend   │
+                └──────┬──────┘
+        ┌──────────────┼────────────────┐
+        │              │                │
+┌───────▼───────┐ ┌────▼────────┐ ┌─────▼─────────┐
+|Deployment App │ │ Monitoring  │ │ Governance    │
+│ (Docker + API)│ │ (Drift etc) │ │ (Policies)    │
+└───────────────┘ └─────────────┘ └───────────────┘
+```
+
+---
+
+## 📦 Core Applications
+
+### 1️⃣ Deployment App
+
+Responsible for **deploying ML models as real services**.
+
+**Key features:**
+
+* Model version management
+* Docker-based deployment
+* Automatic FastAPI inference service
+* Deployment lifecycle tracking (deploying / active / failed)
+* Port governance and runtime control
+
+**Why it matters:**
+
+> Turns ML models into scalable, production-ready APIs.
+
+---
+
+### 2️⃣ Monitoring App
+
+Responsible for **observing model behavior in production**.
+
+**Key features:**
+
+* Collects production features and predictions
+* Performance monitoring (latency, usage)
+* **Data drift & feature drift detection**
+* Drift history tracking
+* Alerting and audit integration
+
+**Drift metrics supported:**
+
+* Population Stability Index (PSI)
+* Kolmogorov–Smirnov test
+* Wasserstein distance
+
+**Why it matters:**
+
+> A model without monitoring is a silent failure waiting to happen.
+
+---
+
+### 3️⃣ Governance App
+
+Responsible for **policies, compliance, and control**.
+
+**Key features:**
+
+* Declarative governance policies (YAML / metadata-based)
+* Role-based access control (RBAC)
+* Policy enforcement across deployment & monitoring
+* Violation tracking
+* Read-only audit access
+
+**An example of Metadata-based**
+
+# metadata.yaml
+* version: 1.0
+
+### =========================
+## Role-Based Access Control
+### =========================
+> role_permissions:
+  * admin:
+    - deployment:*
+    - monitoring:*
+    - governance:*
+    - audit:read
+
+  * engineer:
+    - deployment:read
+    - deployment:write
+    - monitoring:read
+
+  * auditor:
+    - audit:read
+
+### =========================
+## Deployment Runtime Config
+### =========================
+> deployment:
+  * id : deployment.id,
+  * name : deployment.name,
+  * port : deployment.port,
+  * status : deployment.status,
+
+### =========================
+## Drift Monitoring Config
+### =========================
+> drift_monitoring:
+  * enabled: true
+
+  * check_strategy:
+    - type: request_based              # request_based | time_based
+    - every_n_requests: 1000           # used if request_based
+    - interval_minutes: 60             # used if time_based
+
+> monitoring: 
+  * enabled: True
+
+                
+            
+
+> metrics:
+
+    * psi:
+       - enabled: true
+       - warning: 0.1
+       - critical: 0.25
+    
+    * ks_test:
+       - enabled: true
+       - p_value_threshold: 0.05
+
+    * wasserstein:
+      - enabled: true
+      - warning: 0.2
+
+  
+
+**Example policies:**
+
+* Block deployment outside allowed port ranges
+* Freeze models when severe drift is detected
+* Restrict actions based on user roles
+* Require manual approval for risky operations
+
+---
+
+### 4️⃣ AIAC – Command Line Interface
+
+**professional CLI** for interacting with the platform.
+
+**Built with:**
+
+* Typer
+* Rich
+
+**Capabilities:**
+
+* Deploy and manage models
+* Monitor metrics and drift
+* Inspect audit logs
+* Validate governance policies
+* Automate workflows (CI/CD friendly)
+
+**Why CLI?**
+
+* Designed for ML Engineers & DevOps
+* Scriptable and automatable
+* Faster and more reliable than GUIs
+
+---
+
+## �️ CLI Commands Reference
+
+The AIAC CLI provides comprehensive command-line access to all platform features. Commands are organized into logical groups for easy navigation.
+
+### Authentication Commands
+
+```bash
+# Register a new user account
+aiac auth register
+
+# Login to get access tokens
+aiac auth login
+
+# Logout and invalidate tokens
+aiac auth logout
+```
+
+### Deployment Commands
+
+```bash
+# Project Management
+aiac deployment create-project-deployment    # Create a new project
+aiac deployment list-projects               # List all projects
+aiac deployment delete-project              # Delete a project
+
+# Model Version Management
+aiac deployment create-model-version        # Create a new model version
+aiac deployment list-model-versions         # List all model versions
+aiac deployment delete-model-version        # Delete a model version
+
+# Deployment Operations
+aiac deployment deploy-model-version        # Deploy a model version
+aiac deployment redeploy-model              # Redeploy an existing deployment
+aiac deployment stop-deployment             # Stop a running deployment
+aiac deployment delete-deployment           # Delete a deployment
+aiac deployment list-deployments            # List all deployments
+aiac deployment get-deployment-details      # Get detailed deployment info
+```
+
+### Monitoring Commands
+
+```bash
+# Deployment Monitoring
+aiac monitoring deploy-stats                # View deployment statistics
+aiac monitoring deploy-records              # View deployment monitoring records
+aiac monitoring alert                       # View deployment alerts
+
+# Alert Management
+aiac monitoring resolve-alert               # Resolve a specific alert
+
+# Data Drift Detection
+aiac monitoring detect-drift                # Check for data drift on model version
+aiac monitoring samples                     # Post samples for drift analysis
+```
+
+### Governance Commands
+
+```bash
+# Policy Management
+aiac governance create-policy               # Create a new governance policy
+aiac governance list-policies               # List all governance policies
+aiac governance delete-policy               # Delete a governance policy
+
+# Policy Application
+aiac governance apply-policy                # Apply a policy to a deployment
+
+# Compliance Monitoring
+aiac governance view-violations             # View policy violations
+aiac governance metrics                     # View violation metrics
+aiac governance alert-logs                  # View alert logs for violations
+```
+
+### Command Usage Examples
+
+```bash
+# Complete workflow example
+aiac auth login                                    # Authenticate first
+aiac deployment create-project-deployment          # Create project
+aiac deployment create-model-version               # Add model version
+aiac deployment deploy-model-version               # Deploy the model
+aiac monitoring deploy-stats                       # Monitor performance
+aiac governance create-policy                      # Set up governance
+aiac governance apply-policy                       # Apply policy to deployment
+```
+
+### Interactive Prompts
+
+Most commands use interactive prompts for required parameters:
+
+```bash
+aiac deployment create-project-deployment
+# Will prompt for: owner, project_name, description
+
+aiac deployment deploy-model-version
+# Will prompt for: user_id, model_version_id, port
+```
+
+### Output Formatting
+
+Commands use **Rich** library for beautiful terminal output:
+- 📊 **Tables** for listing data
+- 🎨 **Colored output** for status and warnings
+- 📋 **Structured information** display
+- ⚠️ **Clear error messages** and success confirmations
+
+---
+
+## 🔗 API Endpoints
+
+The platform provides REST APIs for all functionality. Key endpoints include:
+
+### Authentication
+- `POST /api/auth/login/` - User login
+- `POST /api/auth/register/` - User registration
+- `POST /api/auth/logout/` - User logout
+
+### Deployment Management
+- `GET /api/deployments/projects/` - List projects
+- `POST /api/deployments/projects/` - Create project
+- `GET /api/deployments/versions/` - List model versions
+- `POST /api/deployments/versions/` - Create model version
+- `POST /api/deployments/deploy/` - Deploy model
+- `GET /api/deployments/` - List deployments
+
+### Monitoring
+- `GET /api/monitoring/stats/` - Deployment statistics
+- `POST /api/monitoring/drift/` - Check data drift
+- `GET /api/monitoring/alerts/` - List alerts
+
+### Governance
+- `GET /api/governance/policies/` - List policies
+- `POST /api/governance/policies/` - Create policy
+- `GET /api/governance/violations/` - List violations
+
+## 🔐 Authentication & Security
+
+### JWT Token Authentication
+
+The platform uses JWT (JSON Web Tokens) for API authentication:
+
+1. **Login** to get access and refresh tokens
+2. **Include token** in Authorization header: `Bearer <access_token>`
+3. **Refresh tokens** when they expire using the refresh endpoint
+
+### Role-Based Access Control
+
+Three user roles with different permissions:
+
+- **Admin**: Full access to all features
+- **Engineer**: Deployment and monitoring access
+- **Auditor**: Read-only access to audit logs and compliance data
+
+### Security Features
+
+- ✅ JWT-based authentication
+- ✅ Role-based permissions
+- ✅ API key support for model inference
+- ✅ Service tokens for monitoring agents
+- ✅ Immutable audit logging
+- ✅ Input validation and sanitization
+
+---
+
+## 🧠 Why This Project Matters
+
+* 🔹 Combines **ML, Backend, DevOps, and Governance**
+* 🔹 Inspired by real-world platforms:
+
+  * AWS SageMaker
+  * Google Vertex AI
+  * MLflow + Kubernetes ecosystems
+* 🔹 Suitable for:
+
+  * Advanced learning
+  * Research-to-production workflows
+  * Startup or enterprise foundations
+* 🔹 Fully extensible and modular
+
+---
+
+## � Docker Deployment
+
+The platform supports containerized deployment for production environments.
+
+### Quick Start with Docker Compose
+
+```bash
+# Clone the repository
+git clone https://github.com/AyoubArdem/ai-accelerator.git
+cd ai-accelerator
+
+# Start all services
+docker-compose up -d
+
+# Services will be available at:
+# - Django API: http://localhost:8000
+# - PostgreSQL: localhost:5432
+# - Redis: localhost:6379
+```
+
+### Docker Services
+
+- **web**: Django application server
+- **db**: PostgreSQL database
+- **redis**: Redis cache and message broker
+- **celery**: Asynchronous task worker
+
+### Environment Configuration
+
+Create a `.env` file for configuration:
+
+```env
+# Database
+DATABASE_URL=postgresql://user:password@db:5432/ai_accelerator
+
+# Redis
+REDIS_URL=redis://redis:6379/0
+
+# Django
+SECRET_KEY=your-secret-key-here
+DEBUG=False
+ALLOWED_HOSTS=localhost,127.0.0.1
+
+# JWT
+JWT_SECRET_KEY=your-jwt-secret
+```
+
+### Building Custom Images
+
+```bash
+# Build the application image
+docker build -t ai-accelerator:latest .
+
+# Run with custom configuration
+docker run -p 8000:8000 \
+  -e DATABASE_URL=postgresql://... \
+  -e REDIS_URL=redis://... \
+  ai-accelerator:latest
+```
+## 📦 Requirements & Dependencies
+
+### System Requirements
+
+- **Python**: 3.8 or higher
+- **Docker**: For containerized model deployment
+- **PostgreSQL**: Primary database (or SQLite for development)
+- **Redis**: For Celery task queue and caching
+
+### Core Dependencies
+
+When you install `ai-accelerator`, the following key dependencies are automatically included:
+
+**Main requirements:**
+- `Django>=5.2.8` - Web framework
+- `djangorestframework>=3.14.0` - API framework
+- `djangorestframework-simplejwt>=5.3.0` - JWT authentication
+- `drf-spectacular>=0.26.5` - API documentation
+- `django-cors-headers>=4.3.1` - CORS handling
+- `python-decouple>=3.8` - Environment variable management
+- `psycopg2-binary>=2.9.9` - PostgreSQL adapter
+- `celery>=5.3.4` - Asynchronous task queue
+- `django-redis>=5.4.0` - Redis cache backend
+- `redis>=5.0.1` - Redis client
+- `PyJWT>=2.8.0` - JWT token handling
+
+**CLI requirements:**
+- `typer>=0.9.0` - Command-line interface framework
+- `rich>=13.7.0` - Beautiful terminal output
+- `docker>=7.0.0` - Container management
+- `requests>=2.31.0` - HTTP client
+
+**AI/ML requirements:**
+- `numpy>=1.24.3` - Numerical computing
+- `scipy>=1.11.4` - Scientific computing
+- `tensorflow>=2.15.0` - Deep learning framework
+
+### Development Setup
+
+For contributors and advanced users who want to run from source:
+
+1. **Clone and setup:**
+   ```bash
+   git clone https://github.com/AyoubArdem/ai-accelerator.git
+   cd ai-accelerator
+   python -m venv env1
+   source env1/bin/activate  # On Windows: env1\Scripts\activate
+   ```
+
+2. **Install all dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   pip install -r deployment/requirements.txt
+   pip install -r monitoring/requirements.txt
+   pip install -r governance/requirements.txt
+   ```
+
+3. **Database setup:**
+   ```bash
+   # For development (SQLite)
+   python manage.py migrate
+
+   # For production (PostgreSQL)
+   # Configure DATABASE_URL in .env file
+   python manage.py migrate
+   ```
+
+4. **Create superuser:**
+   ```bash
+   python manage.py createsuperuser
+   ```
+
+### Optional Development Dependencies
+
+Install additional development tools:
+
+```bash
+pip install -e ".[dev]"
+```
+
+This includes:
+- `pytest>=7.4.3` - Testing framework
+- `pytest-django>=4.5.2` - Django testing utilities
+- `black>=23.12.1` - Code formatting
+- `flake8>=6.1.0` - Linting
+- `isort>=5.13.2` - Import sorting
+- `pre-commit>=3.6.0` - Git hooks
+
+---
+## � API Documentation
+
+The platform provides comprehensive API documentation through **Swagger UI**, allowing you to explore and test all available endpoints interactively.
+
+### Accessing Swagger UI
+
+1. **Start the Django development server:**
+   ```bash
+   python manage.py runserver
+   ```
+
+2. **Open your browser and navigate to:**
+   ```
+   http://127.0.0.1:8000/api/schema/swagger-ui/
+   ```
+
+3. **Alternative documentation formats:**
+   - **Redoc UI:** `http://127.0.0.1:8000/api/schema/redoc/`
+   - **Raw OpenAPI Schema:** `http://127.0.0.1:8000/api/schema/`
+
+### What you'll find in the documentation:
+
+* 🔍 **Interactive API Explorer** - Test endpoints directly from the browser
+* 📋 **Complete endpoint listing** - All available API operations
+* 📝 **Request/Response schemas** - Detailed data structures
+* 🔐 **Authentication requirements** - JWT token usage
+* 📊 **Model schemas** - Data models and relationships
+
+### Authentication
+
+To test protected endpoints, you'll need to:
+
+1. Obtain a JWT token from the authentication endpoints
+2. Click "Authorize" in Swagger UI
+3. Enter your token in the format: `Bearer <your-jwt-token>`
+
+---
+
+## 🚀 Project Status
+
+**AI Accelerator v0.1.0** is now available on PyPI! 🎉
+
+### Current Status
+- ✅ **Core functionality** implemented and tested
+- ✅ **PyPI package** published and installable
+- ✅ **CLI tool** fully functional
+- ✅ **API documentation** complete
+- ✅ **Docker support** for containerized deployment
+
+### Roadmap (Future Releases)
+
+#### v0.2.0 - Enhanced Monitoring
+- [ ] Advanced drift visualization
+- [ ] Custom monitoring metrics
+- [ ] Alert notification system (email/webhooks)
+- [ ] Performance benchmarking tools
+
+#### v0.3.0 - Web Dashboard
+- [ ] React-based admin interface
+- [ ] Real-time monitoring dashboard
+- [ ] Model performance analytics
+- [ ] Governance policy editor
+
+#### v0.4.0 - Enterprise Features
+- [ ] Multi-tenant architecture
+- [ ] Advanced RBAC with custom roles
+- [ ] Audit log export and compliance reports
+- [ ] Integration with cloud platforms (AWS, GCP, Azure)
+
+#### v0.5.0 - Automation & Pipelines
+- [ ] Automated model retraining
+- [ ] CI/CD pipeline integration
+- [ ] A/B testing framework
+- [ ] Model versioning with Git integration
+
+### Stability
+- **Core APIs**: Stable for production use
+- **CLI Interface**: Stable and backward compatible
+- **Database Schema**: Stable with migration support
+- **Docker Images**: Production-ready
+
+### Support
+- 💬 **Discussions**: [GitHub Discussions](https://github.com/AyoubArdem/AI_Accelerator/discussions)
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions from the community! Here's how to get started:
+
+### Development Setup
+
+```bash
+# Fork and clone the repository
+git clone https://github.com/your-username/ai-accelerator.git
+cd ai-accelerator
+
+# Create virtual environment
+python -m venv env1
+source env1/bin/activate  # On Windows: env1\Scripts\activate
+
+# Install in development mode with dev dependencies
+pip install -e ".[dev]"
+
+# Run database migrations
+python manage.py migrate
+
+# Create a superuser
+python manage.py createsuperuser
+
+# Run tests
+pytest
+
+# Start development server
+python manage.py runserver
+```
+
+### Code Quality
+
+We use several tools to maintain code quality:
+
+```bash
+# Format code
+black .
+
+# Sort imports
+isort .
+
+# Lint code
+flake8 .
+
+# Run all checks
+pre-commit run --all-files
+```
+
+### Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=aiac --cov=AI_Accelerator
+
+# Run specific test file
+pytest tests/test_deployment.py
+```
+
+### Pull Request Process
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/amazing-feature`
+3. Make your changes and add tests
+4. Ensure all tests pass: `pytest`
+5. Format your code: `black . && isort .`
+6. Commit your changes: `git commit -m 'Add amazing feature'`
+7. Push to the branch: `git push origin feature/amazing-feature`
+8. Open a Pull Request
+
+### Areas for Contribution
+
+- 🐛 **Bug fixes** - Help us squash bugs
+- ✨ **New features** - Add monitoring metrics, governance policies, etc.
+- 📚 **Documentation** - Improve docs, add tutorials, examples
+- 🧪 **Testing** - Add more comprehensive tests
+- 🎨 **UI/UX** - Web dashboard, improved CLI output
+- 🔧 **DevOps** - Kubernetes support, CI/CD improvements
+
+
+
+
+
+## 🙏 Acknowledgments
+
+AI Accelerator builds upon the excellent work of the open-source community:
+
+- **Django** & **Django REST Framework** - Web framework foundation
+- **Typer** & **Rich** - CLI framework and beautiful output
+- **Celery** - Asynchronous task processing
+- **Docker** - Containerization platform
+- **TensorFlow** - Machine learning framework
+- **PostgreSQL** & **Redis** - Data storage and caching
+
+Special thanks to all contributors and the MLOps community for inspiration and feedback.
+
+## 📄 License
+
+This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.
+
+```
+Copyright 2026 Ayoub Ardem
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+---
+
+## 📞 Contact & Support
+
+- **Email**: [ayoub.ardem@example.com]
+- **GitHub**: [@AyoubArdem](https://github.com/AyoubArdem)
+- **LinkedIn**: [https://www.linkedin.com/in/ayoub-student-08832b2b3]
+
+---
+
+**AI Accelerator** is more than a project — it's a **production-grade AI platform blueprint**.
+
+> Our goal is to make AI deployment, monitoring, and governance structured, secure, and scalable — from experimentation to real-world impact.
+
+🚀 **Let's build the future of AI infrastructure together!**
+