feat: implement zero-config system with Node.js 22 compatibility

- Add comprehensive zero-config preset system (production, development, minimal)
- Implement intelligent auto-configuration for models and storage
- Add Node.js version enforcement for ONNX Runtime stability
- Force single-threaded ONNX operations to prevent V8 HandleScope crashes
- Create extensible configuration architecture
- Add 14 distributed system presets for enterprise deployments
- Include detailed documentation and migration guides

BREAKING CHANGE: Now requires Node.js 22.x LTS for optimal stability
This commit is contained in:
David Snelling 2025-08-29 15:39:07 -07:00
parent 4d60384755
commit 5f862bad98
20 changed files with 3718 additions and 71 deletions

View file

@ -0,0 +1,228 @@
/**
* Model Configuration Auto-Selection
* Intelligently selects model precision based on environment
* while allowing manual override
*/
import { isBrowser, isNode } from '../utils/environment.js'
export type ModelPrecision = 'fp32' | 'q8'
export type ModelPreset = 'fast' | 'small' | 'auto'
interface ModelConfigResult {
precision: ModelPrecision
reason: string
autoSelected: boolean
}
/**
* Auto-select model precision based on environment and resources
* @param override - Manual override: 'fp32', 'q8', 'fast' (fp32), 'small' (q8), or 'auto'
*/
export function autoSelectModelPrecision(override?: ModelPrecision | ModelPreset): ModelConfigResult {
// Handle direct precision override
if (override === 'fp32' || override === 'q8') {
return {
precision: override,
reason: `Manually specified: ${override}`,
autoSelected: false
}
}
// Handle preset overrides
if (override === 'fast') {
return {
precision: 'fp32',
reason: 'Preset: fast (fp32 for best quality)',
autoSelected: false
}
}
if (override === 'small') {
return {
precision: 'q8',
reason: 'Preset: small (q8 for reduced size)',
autoSelected: false
}
}
// Auto-selection logic
return autoDetectBestPrecision()
}
/**
* Automatically detect the best model precision for the environment
*/
function autoDetectBestPrecision(): ModelConfigResult {
// Browser environment - use Q8 for smaller download/memory
if (isBrowser()) {
return {
precision: 'q8',
reason: 'Browser environment detected - using Q8 for smaller size',
autoSelected: true
}
}
// Serverless environments - use Q8 for faster cold starts
if (isServerlessEnvironment()) {
return {
precision: 'q8',
reason: 'Serverless environment detected - using Q8 for faster cold starts',
autoSelected: true
}
}
// Check available memory
const memoryMB = getAvailableMemoryMB()
if (memoryMB < 512) {
return {
precision: 'q8',
reason: `Low memory detected (${memoryMB}MB) - using Q8`,
autoSelected: true
}
}
// Development environment - use FP32 for best quality
if (process.env.NODE_ENV === 'development') {
return {
precision: 'fp32',
reason: 'Development environment - using FP32 for best quality',
autoSelected: true
}
}
// Production with adequate memory - use FP32
if (memoryMB >= 2048) {
return {
precision: 'fp32',
reason: `Adequate memory (${memoryMB}MB) - using FP32 for best quality`,
autoSelected: true
}
}
// Default to Q8 for moderate memory environments
return {
precision: 'q8',
reason: `Moderate memory (${memoryMB}MB) - using Q8 for balance`,
autoSelected: true
}
}
/**
* Check if running in a serverless environment
*/
function isServerlessEnvironment(): boolean {
if (!isNode()) return false
return !!(
process.env.AWS_LAMBDA_FUNCTION_NAME ||
process.env.VERCEL ||
process.env.NETLIFY ||
process.env.CLOUDFLARE_WORKERS ||
process.env.FUNCTIONS_WORKER_RUNTIME ||
process.env.K_SERVICE // Google Cloud Run
)
}
/**
* Get available memory in MB
*/
function getAvailableMemoryMB(): number {
if (isBrowser()) {
// @ts-ignore - navigator.deviceMemory is experimental
if (navigator.deviceMemory) {
// @ts-ignore
return navigator.deviceMemory * 1024 // Device memory in GB
}
return 256 // Conservative default for browsers
}
if (isNode()) {
try {
// Try to get memory info synchronously for Node.js
// This will be available in Node.js environments
if (typeof process !== 'undefined' && process.memoryUsage) {
// Use RSS (Resident Set Size) as a proxy for available memory
const rss = process.memoryUsage().rss
// Assume we can use up to 4GB or 50% more than current usage
return Math.min(4096, Math.floor(rss / (1024 * 1024) * 1.5))
}
} catch {
// Fall through to default
}
return 1024 // Default 1GB for Node.js
}
return 512 // Conservative default
}
/**
* Convenience function to check if models need to be downloaded
* This replaces the need for BRAINY_ALLOW_REMOTE_MODELS
*/
export function shouldAutoDownloadModels(): boolean {
// Always allow downloads unless explicitly disabled
// This eliminates the need for BRAINY_ALLOW_REMOTE_MODELS
const explicitlyDisabled = process.env.BRAINY_ALLOW_REMOTE_MODELS === 'false'
if (explicitlyDisabled) {
console.warn('Model downloads disabled via BRAINY_ALLOW_REMOTE_MODELS=false')
return false
}
// In production, always allow downloads for seamless operation
if (process.env.NODE_ENV === 'production') {
return true
}
// In development, allow downloads with a one-time notice
if (process.env.NODE_ENV === 'development') {
return true
}
// Default: allow downloads
return true
}
/**
* Get the model path with intelligent defaults
* This replaces the need for BRAINY_MODELS_PATH env var
*/
export function getModelPath(): string {
// Check if user explicitly set a path (keeping this for advanced users)
if (process.env.BRAINY_MODELS_PATH) {
return process.env.BRAINY_MODELS_PATH
}
// Browser - use cache API or IndexedDB (handled by transformers.js)
if (isBrowser()) {
return 'browser-cache'
}
// Serverless - use /tmp for ephemeral storage
if (isServerlessEnvironment()) {
return '/tmp/.brainy/models'
}
// Node.js - use home directory for persistent storage
if (isNode()) {
// Use process.env.HOME as a fallback
const homeDir = process.env.HOME || process.env.USERPROFILE || '~'
return `${homeDir}/.brainy/models`
}
// Fallback
return './.brainy/models'
}
/**
* Log model configuration decision (only in verbose mode)
*/
export function logModelConfig(config: ModelConfigResult, verbose: boolean = false): void {
if (!verbose && process.env.NODE_ENV === 'production') {
return // Silent in production unless verbose
}
const icon = config.autoSelected ? '🤖' : '👤'
console.log(`${icon} Model: ${config.precision.toUpperCase()} - ${config.reason}`)
}