Merge pull request #6 from intersystems-community/003-enhance-documentation-in

003 enhance documentation in

Author: isc-tdyar

.env.example

@@ -1,9 +1,9 @@
 # =============================================================================
-# IntegratedML Flexible Model Integration Environment Configuration
+# IntegratedML Custom Models Environment Configuration
 # =============================================================================
-# 
+#
 # This file serves as a template for environment variables required by the
-# IntegratedML Flexible Model Integration project. Copy this file to .env and fill in 
+# IntegratedML Custom Models project. Copy this file to .env and fill in
 # the actual values.
 #
 # SECURITY NOTE: Never commit .env files with real secrets to version control.
@@ -172,11 +172,11 @@ ENABLE_PROFILING=false
 
 # Optional: MLflow tracking (for experiment management)
 # MLFLOW_TRACKING_URI=http://localhost:5000
-# MLFLOW_EXPERIMENT_NAME=IntegratedML_Flexible_Model_Integration
+# MLFLOW_EXPERIMENT_NAME=IntegratedML_Custom_Models
 
 # Optional: Weights & Biases (for experiment tracking)
 # WANDB_API_KEY=your-wandb-api-key
-# WANDB_PROJECT=integratedml-flexible-model-integration
+# WANDB_PROJECT=integratedml-custom-models
 
 # =============================================================================
 # CI/CD Configuration

.github/REPOSITORY_SETUP.md

@@ -1,6 +1,6 @@
 # Repository Setup Guide for GitHub Publication
 
-This guide provides templates and recommendations for optimizing the IntegratedML Flexible Model Integration repository for maximum discoverability and community engagement.
+This guide provides templates and recommendations for optimizing the IntegratedML Custom Models repository for maximum discoverability and community engagement.
 
 ## 📝 Repository Description Template
 
@@ -25,7 +25,7 @@ Database-integrated ML demos: 4 enterprise examples showcasing IntegratedML plug
 - `intersystems-iris`
 - `machine-learning`
 - `database-ml`
-- `flexible-model-integration`
+- `custom-models`
 - `scikit-learn`
 - `python`
 
@@ -67,7 +67,7 @@ Database-integrated ML demos: 4 enterprise examples showcasing IntegratedML plug
 
 ### LinkedIn Post Template
 ```
-🚀 New open-source project: IntegratedML Flexible Model Integration Demo
+🚀 New open-source project: IntegratedML Custom Models Demo
 
 ✅ 4 progressive ML demos (Credit Risk → DNA Analysis)
 ✅ 67ms average latency, 95.4% accuracy validated
@@ -78,24 +78,24 @@ Perfect for learning database-integrated ML workflows!
 
 #MachineLearning #InterSystems #OpenSource #MLOps #DataScience
 
-https://github.com/intersystems-community/integratedml-flexible-model-integration
+https://github.com/intersystems-community/integratedml-custom-models
 ```
 
 ### Twitter/X Post Template
 ```
-🧬 New: IntegratedML Flexible Model Integration Demo
+🧬 New: IntegratedML Custom Models Demo
 
 4 enterprise ML examples:
 🏦 Credit Risk (Beginner)
-🚨 Fraud Detection (67ms!)  
+🚨 Fraud Detection (67ms!)
 📈 Sales Forecasting
 🧬 DNA Analysis
 
 B+ code quality, full CI/CD, <100ms predictions
 
 #ML #OpenSource #DataScience
 
-https://github.com/intersystems-community/integratedml-flexible-model-integration
+https://github.com/intersystems-community/integratedml-custom-models
 ```
 
 ### Reddit Post Ideas
@@ -235,12 +235,12 @@ Enterprise-ready ML demos for IntegratedML: 4 progressive examples from credit r
 
 ### Topics (Comma-separated)
 ```
-integratedml, intersystems-iris, machine-learning, database-ml, flexible-model-integration, scikit-learn, python, credit-risk-assessment, fraud-detection, sales-forecasting, dna-analysis, enterprise-ml, production-ml, intersystems-community, open-source, demo-project, tutorial, best-practices
+integratedml, intersystems-iris, machine-learning, database-ml, custom-models, scikit-learn, python, credit-risk-assessment, fraud-detection, sales-forecasting, dna-analysis, enterprise-ml, production-ml, intersystems-community, open-source, demo-project, tutorial, best-practices
 ```
 
 ### Website URL
 ```
-https://intersystems-community.github.io/integratedml-flexible-model-integration/
+https://intersystems-community.github.io/integratedml-custom-models/
 ```
 
 ---

Makefile

@@ -1,11 +1,11 @@
-# IntegratedML Flexible Model Integration - Development Automation
+# IntegratedML Custom Models - Development Automation
 # Simplified workflow for IRIS + local development
 
 .PHONY: help setup start stop clean install test format lint notebooks
 
 # Default target
 help:
-	@echo "IntegratedML Flexible Model Integration - Available Commands:"
+	@echo "IntegratedML Custom Models - Available Commands:"
 	@echo ""
 	@echo "Setup & Environment:"
 	@echo "  setup     - Complete project setup (dependencies + IRIS)"

README.md

@@ -5,6 +5,32 @@
 [![IRIS 2025.2](https://img.shields.io/badge/IRIS-2025.2-blue.svg)](https://www.intersystems.com)
 [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![EAP Status](https://img.shields.io/badge/status-Early%20Access%20Program-orange.svg)](docs/EAP_GUIDE.md)
+
+---
+
+## 🚀 Early Access Program (EAP)
+
+**Welcome EAP Participants!** You're among a select group of 5 participants helping shape this feature before the IRIS 2026.1 GA release.
+
+### Getting Started with EAP
+1. **[Read the EAP Guide](docs/EAP_GUIDE.md)** - Understand the program, timeline, and expectations
+2. **[Install Custom Models](docs/INSTALLATION.md)** - Complete installation in <30 minutes (target)
+3. **[Check Known Issues](docs/EAP_KNOWN_ISSUES.md)** - Review current limitations before reporting bugs
+4. **[Review Roadmap](docs/EAP_ROADMAP.md)** - See what's coming from EAP to GA
+
+### How to Provide Feedback
+Your feedback directly shapes the final product! Choose your preferred channel:
+
+- **Survey** (recommended): Survey links provided by Data Platforms Product Team
+- **Email**: [thomas.dyar@intersystems.com](mailto:thomas.dyar@intersystems.com)
+- **GitHub Issues** (if enabled): Technical bugs and feature requests
+
+**Response time**: 1-2 business days during EAP
+
+For questions or support, see [EAP FAQ](docs/EAP_FAQ.md) or email thomas.dyar@intersystems.com.
+
+---
 
 ## Table of Contents
 
@@ -25,7 +51,7 @@
 
 ## Overview
 
-IntegratedML Custom Models allows you to deploy custom Python models directly within SQL queries. This feature enables in-database machine learning without data movement, making it easier to integrate ML models into existing database workflows.
+**IntegratedML Custom Models** extends InterSystems IRIS IntegratedML with a powerful new capability: deploy your own Python models directly within SQL queries. While IntegratedML has provided automated ML for years, this feature gives data scientists full control—custom preprocessing, any scikit-learn compatible model, and third-party libraries like Prophet or LightGBM—all executing in-database without data movement.
 
 ```sql
 -- Train your custom Python model with a single SQL command
@@ -127,13 +153,22 @@ make demo-dna
 
 This project's documentation is organized into three main areas:
 
+### 🔶 EAP Documentation (Start Here!)
+Essential guides for Early Access Program participants:
+- **[EAP Guide](docs/EAP_GUIDE.md)** - Program overview, timeline, feedback channels
+- **[Installation Guide](docs/INSTALLATION.md)** - Platform-specific setup (macOS primary, Linux/Windows secondary)
+- **[Known Issues](docs/EAP_KNOWN_ISSUES.md)** - Current limitations and workarounds
+- **[EAP Roadmap](docs/EAP_ROADMAP.md)** - Features from EAP to GA (2026.1)
+- **[EAP FAQ](docs/EAP_FAQ.md)** - Frequently asked questions
+- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
+
 ### 📚 Core Documentation ([`docs/`](docs/))
 Cross-cutting technical documentation for the entire project:
 - **[Quick Start Guide](docs/QUICK_GUIDE_CUSTOM_MODELS.md)** - Get started in under 5 minutes
+- **[User Guide](docs/user_guide.md)** - Step-by-step usage instructions
 - **[Architecture](docs/architecture.md)** - System design, base class hierarchy, integration patterns
 - **[API Reference](docs/api_reference.md)** - Complete API documentation for all model classes
 - **[Deployment](docs/deployment.md)** - Production deployment strategies and configuration
-- **[User Guide](docs/user_guide.md)** - Step-by-step usage instructions
 
 ### 🎯 Demo Applications ([`demos/`](demos/))
 Working examples with demo-specific setup instructions:

docker-compose.yml

@@ -1,4 +1,4 @@
-# IntegratedML Flexible Model Integration - Simplified Docker Setup
+# IntegratedML Custom Models - Simplified Docker Setup
 # IRIS database only - users run notebooks in VS Code locally
 
 version: '3.8'