v3/@claude-flow/neural/docs/SONA_INTEGRATION.md
Integration of @ruvector/sona package (v0.1.5) into the V3 Neural Module.
The SONA (Self-Optimizing Neural Architecture) integration provides runtime-adaptive learning capabilities with sub-millisecond performance:
The package is already installed as a dependency:
npm install @ruvector/[email protected]
import {
createSONALearningEngine,
type Trajectory,
type Context,
} from '@claude-flow/neural';
import { getModeConfig } from '@claude-flow/neural';
// Create SONA engine with balanced mode
const modeConfig = getModeConfig('balanced');
const sona = createSONALearningEngine('balanced', modeConfig);
// Learn from a trajectory
const trajectory: Trajectory = {
trajectoryId: 'traj-001',
context: 'Implement authentication',
domain: 'code',
steps: [
{
stepId: 'step-1',
timestamp: Date.now(),
action: 'analyze requirements',
stateBefore: new Float32Array(768).fill(0.1),
stateAfter: new Float32Array(768).fill(0.2),
reward: 0.8,
},
// ... more steps
],
qualityScore: 0.88,
isComplete: true,
startTime: Date.now(),
};
await sona.learn(trajectory);
console.log(`Learning time: ${sona.getLearningTime()}ms`);
// Adapt to new context
const context: Context = {
domain: 'code',
queryEmbedding: new Float32Array(768).fill(0.15),
};
const adapted = await sona.adapt(context);
console.log(`Confidence: ${adapted.confidence}`);
console.log(`Suggested route: ${adapted.suggestedRoute}`);
SONALearningEngineMain class for SONA learning operations.
new SONALearningEngine(mode: SONAMode, modeConfig: SONAModeConfig)
mode: Learning mode ('real-time' | 'balanced' | 'research' | 'edge' | 'batch')modeConfig: Configuration for the mode (from getModeConfig())learn(trajectory: Trajectory): Promise<void>Learn from a completed trajectory.
Performance target: <0.05ms
await sona.learn(trajectory);
adapt(context: Context): Promise<AdaptedBehavior>Adapt behavior based on current context.
Performance target: <0.1ms
const adapted = await sona.adapt({
domain: 'code',
queryEmbedding: embedding,
});
Returns:
transformedQuery: Query after micro-LoRA transformationpatterns: Similar learned patternssuggestedRoute: Recommended model/routeconfidence: Confidence score (0-1)getAdaptationTime(): numberGet the last adaptation time in milliseconds.
const timeMs = sona.getAdaptationTime();
getLearningTime(): numberGet the last learning time in milliseconds.
const timeMs = sona.getLearningTime();
resetLearning(): voidReset all learning state and create a fresh engine.
sona.resetLearning();
forceLearning(): stringForce an immediate background learning cycle.
const status = sona.forceLearning();
console.log(status);
tick(): string | nullTick background learning (call periodically).
const status = sona.tick();
if (status) console.log(status);
getStats(): SONAStatsGet engine statistics.
const stats = sona.getStats();
console.log(`Trajectories: ${stats.totalTrajectories}`);
console.log(`Patterns: ${stats.patternsLearned}`);
console.log(`Avg Quality: ${stats.avgQuality}`);
setEnabled(enabled: boolean): voidEnable or disable the engine.
sona.setEnabled(false); // Disable learning
isEnabled(): booleanCheck if engine is enabled.
if (sona.isEnabled()) {
// Learning is active
}
findPatterns(queryEmbedding: Float32Array, k: number): JsLearnedPattern[]Find k similar learned patterns.
const patterns = sona.findPatterns(embedding, 5);
patterns.forEach(p => {
console.log(`Quality: ${p.avgQuality}, Cluster: ${p.clusterSize}`);
});
Optimized for minimum latency:
const sona = createSONALearningEngine('real-time', getModeConfig('real-time'));
Balanced performance and quality:
const sona = createSONALearningEngine('balanced', getModeConfig('balanced'));
Maximum quality, slower:
const sona = createSONALearningEngine('research', getModeConfig('research'));
Optimized for resource-constrained devices:
const sona = createSONALearningEngine('edge', getModeConfig('edge'));
Optimized for batch processing:
const sona = createSONALearningEngine('batch', getModeConfig('batch'));
Contextinterface Context {
domain: 'code' | 'creative' | 'reasoning' | 'chat' | 'math' | 'general';
queryEmbedding: Float32Array;
metadata?: Record<string, unknown>;
}
AdaptedBehaviorinterface AdaptedBehavior {
transformedQuery: Float32Array;
patterns: JsLearnedPattern[];
suggestedRoute?: string;
confidence: number;
}
SONAStatsinterface SONAStats {
totalTrajectories: number;
patternsLearned: number;
avgQuality: number;
lastLearningMs: number;
enabled: boolean;
}
JsLearnedPatterninterface JsLearnedPattern {
id: string;
centroid: number[];
clusterSize: number;
totalWeight: number;
avgQuality: number;
createdAt: string;
lastAccessed: string;
accessCount: number;
patternType: string;
}
| Mode | Avg Time | Target | Memory |
|---|---|---|---|
| Real-time | ~0.03ms | <0.05ms | 100MB |
| Balanced | ~0.04ms | <0.05ms | 200MB |
| Research | ~0.08ms | <0.10ms | 500MB |
| Edge | ~0.02ms | <0.05ms | 50MB |
| Batch | ~0.05ms | <0.10ms | 1GB |
| Operation | Time |
|---|---|
| Micro-LoRA Apply | ~0.01ms |
| Pattern Search (k=5) | ~0.05ms |
| Total Adaptation | ~0.06ms |
See /examples/sona-usage.ts for comprehensive examples:
Run examples:
cd v3/@claude-flow/neural
npx tsx examples/sona-usage.ts
The SONA integration works seamlessly with other V3 neural components:
import { createNeuralLearningSystem } from '@claude-flow/neural';
const system = createNeuralLearningSystem('balanced');
await system.initialize();
// SONA is used internally by the neural system
const taskId = system.beginTask('Implement feature X', 'code');
// Record steps...
system.recordStep(
taskId,
'analyze requirements',
0.8,
queryEmbedding
);
// Complete and trigger SONA learning
await system.completeTask(taskId, 0.9);
SONA uses native bindings for optimal performance:
Runtime selection is automatic based on platform.
import { SonaEngine, type JsSonaConfig } from '@ruvector/sona';
const customConfig: JsSonaConfig = {
hiddenDim: 512,
embeddingDim: 512,
microLoraRank: 2,
baseLoraRank: 8,
microLoraLr: 0.002,
baseLoraLr: 0.0002,
ewcLambda: 1000.0,
patternClusters: 100,
trajectoryCapacity: 20000,
backgroundIntervalMs: 1800000,
qualityThreshold: 0.6,
enableSimd: true,
};
const engine = SonaEngine.withConfig(customConfig);
SONA automatically runs background learning cycles:
// Tick periodically (e.g., every second)
setInterval(() => {
const status = sona.tick();
if (status) {
console.log('Background learning:', status);
}
}, 1000);
Or force immediate learning:
const status = sona.forceLearning();
console.log(status);
'real-time' or 'edge' modebaseLoraRank in configenableSimd: true)'edge' modetrajectoryCapacitypatternClustershiddenDim and embeddingDimtrajectoryCapacityqualityThresholdbackgroundIntervalMsforceLearning() manuallySONA integration follows the same license as the V3 neural module.