soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

fix: update all imports and references from BrainyData to Brainy

Browse source 
- Fixed imports in examples/tests/ to use correct Brainy import
- Fixed imports in tests/benchmarks/ to use correct paths
- Updated bin/brainy-interactive.js to use Brainy instead of BrainyData
- Corrected documentation references throughout codebase
- Removed duplicate imports in benchmark files
- All files now consistently use 'Brainy' class from dist/index.js
This commit is contained in:
David Snelling 2025-09-30 17:09:15 -07:00
parent 791fac54cd
commit 196690863d
77 changed files with 328 additions and 331 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/CORE_API_PATTERNS.md
View file

@ -34,9 +34,9 @@ await brain.delete(id) // Unified deletion
```typescript
// DON'T DO THIS - Old API patterns
import { BrainyData } from 'old-brainy' // ❌ Wrong import
import { Brainy } from 'old-brainy' // ❌ Wrong import
const brain = new BrainyData({ // ❌ Old class name
const brain = new Brainy({ // ❌ Old class name
complexConfig: true
})

12
docs/CREATING-AUGMENTATIONS.md
View file

@ -57,7 +57,7 @@ export class MyStorageAugmentation extends StorageAugmentation {
```typescript
// Register before brain.init()
const brain = new BrainyData()
const brain = new Brainy()
brain.augmentations.register(new MyStorageAugmentation({
connectionString: 'redis://localhost:6379'
}))
@ -174,9 +174,9 @@ Common operations in Brainy:
```typescript
interface AugmentationContext {
brain: BrainyData // The brain instance
brain: Brainy // The brain instance
storage: StorageAdapter // Storage backend
config: BrainyDataConfig // Configuration
config: BrainyConfig // Configuration
log: (message: string, level?: 'info' | 'warn' | 'error') => void
}
```
@ -265,14 +265,14 @@ Future capability for premium augmentations:
## Testing Your Augmentation
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
import { MyAugmentation } from './my-augmentation'
describe('MyAugmentation', () => {
let brain: BrainyData
let brain: Brainy
beforeEach(async () => {
brain = new BrainyData()
brain = new Brainy()
brain.augmentations.register(new MyAugmentation())
await brain.init()
})

16
docs/EXTENDING_STORAGE.md
View file

@ -59,13 +59,13 @@ Once registered, the new storage type works with zero-config:
```typescript
// Auto-detection will now check Redis
const brain = new BrainyData() // Will use Redis if available!
const brain = new Brainy() // Will use Redis if available!
// Or explicitly specify
const brain = new BrainyData({ storage: 'redis' })
const brain = new Brainy({ storage: 'redis' })
// Or with custom config
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'redis',
redisStorage: {
@ -223,7 +223,7 @@ registerPresetAugmentation('redis-cluster', {
})
// Users can then use:
const brain = new BrainyData('redis-cluster')
const brain = new Brainy('redis-cluster')
```
## Type Safety with Extensions
@ -367,17 +367,17 @@ export class BrainyRedisAugmentation {
}
// Usage after installing the augmentation:
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
import '@soulcraft/brainy-redis' // Registers the augmentation
// Now Redis is automatically detected!
const brain = new BrainyData() // Uses Redis if REDIS_URL is set
const brain = new Brainy() // Uses Redis if REDIS_URL is set
// Or use a Redis preset
const brain = new BrainyData('redis-fast-cache')
const brain = new Brainy('redis-fast-cache')
// Or explicitly configure
const brain = new BrainyData({
const brain = new Brainy({
storage: 'redis',
model: ModelPrecision.FP32
})

2
docs/METADATA_CONTRACT_IMPLEMENTATION.md
View file

@ -35,7 +35,7 @@ These augmentations don't read or write metadata at all:
1. **CacheAugmentation** - Only caches search results
2. **RequestDeduplicatorAugmentation** - Only deduplicates requests
3. **ConnectionPoolAugmentation** - Only manages storage connections
4. **StorageAugmentation** - Base storage layer, metadata handled by brainyData
4. **StorageAugmentation** - Base storage layer, metadata handled by Brainy
### Category 2: Read-Only Access ('readonly')
These augmentations read metadata but never modify it:

8
docs/MODEL_LOADING_QUICK_REFERENCE.md
View file

@ -4,14 +4,14 @@
### ✅ Development (Zero Config)
```typescript
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // Downloads automatically (FP32 default)
```
### ⚡ Development (Optimized - v2.8.0+)
```typescript
// 75% smaller models, 99% accuracy
const brain = new BrainyData({
const brain = new Brainy({
embeddingOptions: { dtype: 'q8' }
})
await brain.init()
@ -55,8 +55,8 @@ export BRAINY_ALLOW_REMOTE_MODELS=false
```html
<!-- Automatic - no setup needed -->
<script type="module">
import { BrainyData } from 'brainy'
const brain = new BrainyData()
import { Brainy } from 'brainy'
const brain = new Brainy()
await brain.init() // Works in browser
</script>
```

4
docs/NEURAL_API_PATTERNS.md
View file

@ -8,8 +8,8 @@
```typescript
// DON'T DO THIS - Outdated documentation patterns
import { BrainyData } from '@soulcraft/brainy' // ❌ Wrong import
const brain = new BrainyData() // ❌ Old class name
import { Brainy } from '@soulcraft/brainy' // ❌ Wrong import
const brain = new Brainy() // ❌ Old class name
// These may not work as expected:
const neural = brain.neural // ❌ May be undefined

24
docs/QUICK-START.md
View file

@ -18,9 +18,9 @@ npm install -g brainy
### 1. Initialize Brainy
```javascript
import { BrainyData, NounType } from '@soulcraft/brainy'
import { Brainy, NounType } from '@soulcraft/brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
```
@ -77,10 +77,10 @@ const libraries = await brain.search("JavaScript", {
### Example 1: Document Search System
```javascript
import { BrainyData, NounType } from '@soulcraft/brainy'
import { Brainy, NounType } from '@soulcraft/brainy'
import fs from 'fs'
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'filesystem',
path: './document-index'
@ -113,9 +113,9 @@ results.forEach(r => console.log(`- ${r.metadata.filename} (${(r.score * 100).to
### Example 2: AI Chat with Memory
```javascript
import { BrainyData, NounType } from '@soulcraft/brainy'
import { Brainy, NounType } from '@soulcraft/brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
class ChatWithMemory {
@ -166,11 +166,11 @@ const response = await chat.chat("What did we discuss about JavaScript?")
### Example 3: Semantic Code Search
```javascript
import { BrainyData, NounType } from '@soulcraft/brainy'
import { Brainy, NounType } from '@soulcraft/brainy'
import { glob } from 'glob'
import fs from 'fs'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Index all JavaScript files
@ -284,12 +284,12 @@ const results = await brain.search("*", {
### Memory (Testing)
```javascript
const brain = new BrainyData() // Default
const brain = new Brainy() // Default
```
### FileSystem (Development)
```javascript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'filesystem',
path: './brain-data'
@ -299,14 +299,14 @@ const brain = new BrainyData({
### Browser (OPFS)
```javascript
const brain = new BrainyData({
const brain = new Brainy({
storage: { type: 'opfs' }
})
```
### S3 (Production)
```javascript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 's3',
bucket: 'my-brain-bucket',

4
docs/README.md
View file

@ -62,10 +62,10 @@ await brain.find("recent articles about AI with high ratings")
## Quick Example
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
// Initialize
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Add entities (nouns)

78
docs/ZERO_CONFIG.md
View file

@ -8,20 +8,20 @@ Starting with v2.10, Brainy introduces a **Zero-Configuration System** that auto
### True Zero Config
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
// That's it! Everything auto-configures
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
```
### Using Strongly-Typed Presets
```typescript
import { BrainyData, PresetName } from '@soulcraft/brainy'
import { Brainy, PresetName } from '@soulcraft/brainy'
// Type-safe preset selection
const brain = new BrainyData(PresetName.PRODUCTION)
const brain = new Brainy(PresetName.PRODUCTION)
await brain.init()
```
@ -29,7 +29,7 @@ await brain.init()
#### Development
```typescript
const brain = new BrainyData(PresetName.DEVELOPMENT)
const brain = new Brainy(PresetName.DEVELOPMENT)
// ✅ Memory storage for fast iteration
// ✅ FP32 models for best quality
// ✅ Verbose logging
@ -38,7 +38,7 @@ const brain = new BrainyData(PresetName.DEVELOPMENT)
#### Production
```typescript
const brain = new BrainyData(PresetName.PRODUCTION)
const brain = new Brainy(PresetName.PRODUCTION)
// ✅ Disk storage for persistence
// ✅ Auto-selected model precision
// ✅ Silent logging
@ -47,7 +47,7 @@ const brain = new BrainyData(PresetName.PRODUCTION)
#### Minimal
```typescript
const brain = new BrainyData(PresetName.MINIMAL)
const brain = new Brainy(PresetName.MINIMAL)
// ✅ Memory storage
// ✅ Q8 models for small size
// ✅ Core features only
@ -60,16 +60,16 @@ Brainy includes specialized presets for distributed and microservice architectur
### Basic Distributed Roles
```typescript
import { BrainyData, PresetName } from '@soulcraft/brainy'
import { Brainy, PresetName } from '@soulcraft/brainy'
// Write-only instance (data ingestion)
const writer = new BrainyData(PresetName.WRITER)
const writer = new Brainy(PresetName.WRITER)
// ✅ Optimized for writes
// ✅ No search index loading
// ✅ Minimal memory usage
// Read-only instance (search API)
const reader = new BrainyData(PresetName.READER)
const reader = new Brainy(PresetName.READER)
// ✅ Optimized for search
// ✅ Lazy index loading
// ✅ Large cache
@ -78,28 +78,28 @@ const reader = new BrainyData(PresetName.READER)
### Service-Specific Presets
```typescript
// High-throughput data ingestion
const ingestion = new BrainyData(PresetName.INGESTION_SERVICE)
const ingestion = new Brainy(PresetName.INGESTION_SERVICE)
// Low-latency search API
const searchApi = new BrainyData(PresetName.SEARCH_API)
const searchApi = new Brainy(PresetName.SEARCH_API)
// Analytics processing
const analytics = new BrainyData(PresetName.ANALYTICS_SERVICE)
const analytics = new Brainy(PresetName.ANALYTICS_SERVICE)
// Edge location cache
const edge = new BrainyData(PresetName.EDGE_CACHE)
const edge = new Brainy(PresetName.EDGE_CACHE)
// Batch processing
const batch = new BrainyData(PresetName.BATCH_PROCESSOR)
const batch = new Brainy(PresetName.BATCH_PROCESSOR)
// Real-time streaming
const streaming = new BrainyData(PresetName.STREAMING_SERVICE)
const streaming = new Brainy(PresetName.STREAMING_SERVICE)
// ML training
const training = new BrainyData(PresetName.ML_TRAINING)
const training = new Brainy(PresetName.ML_TRAINING)
// Lightweight sidecar
const sidecar = new BrainyData(PresetName.SIDECAR)
const sidecar = new Brainy(PresetName.SIDECAR)
```
## Model Precision Control
@ -110,17 +110,17 @@ You can **explicitly specify** model precision when needed:
import { ModelPrecision } from '@soulcraft/brainy'
// Force FP32 (full precision)
const brain = new BrainyData({ model: ModelPrecision.FP32 })
const brain = new Brainy({ model: ModelPrecision.FP32 })
// Force Q8 (quantized, smaller)
const brain = new BrainyData({ model: ModelPrecision.Q8 })
const brain = new Brainy({ model: ModelPrecision.Q8 })
// Use presets
const brain = new BrainyData({ model: ModelPrecision.FAST }) // Maps to fp32
const brain = new BrainyData({ model: ModelPrecision.SMALL }) // Maps to q8
const brain = new Brainy({ model: ModelPrecision.FAST }) // Maps to fp32
const brain = new Brainy({ model: ModelPrecision.SMALL }) // Maps to q8
// Auto-detection (default)
const brain = new BrainyData({ model: ModelPrecision.AUTO })
const brain = new Brainy({ model: ModelPrecision.AUTO })
```
### Auto-Detection Logic
@ -159,13 +159,13 @@ Brainy automatically detects the best storage option:
import { StorageOption } from '@soulcraft/brainy'
// Force specific storage with enum
const brain = new BrainyData({ storage: StorageOption.MEMORY })
const brain = new BrainyData({ storage: StorageOption.DISK })
const brain = new BrainyData({ storage: StorageOption.CLOUD })
const brain = new BrainyData({ storage: StorageOption.AUTO })
const brain = new Brainy({ storage: StorageOption.MEMORY })
const brain = new Brainy({ storage: StorageOption.DISK })
const brain = new Brainy({ storage: StorageOption.CLOUD })
const brain = new Brainy({ storage: StorageOption.AUTO })
// Custom storage configuration
const brain = new BrainyData({
const brain = new Brainy({
storage: {
s3Storage: {
bucket: 'my-bucket',
@ -183,12 +183,12 @@ Control which features are enabled:
import { FeatureSet } from '@soulcraft/brainy'
// Preset feature sets with enum
const brain = new BrainyData({ features: FeatureSet.MINIMAL }) // Core only
const brain = new BrainyData({ features: FeatureSet.DEFAULT }) // Balanced
const brain = new BrainyData({ features: FeatureSet.FULL }) // Everything
const brain = new Brainy({ features: FeatureSet.MINIMAL }) // Core only
const brain = new Brainy({ features: FeatureSet.DEFAULT }) // Balanced
const brain = new Brainy({ features: FeatureSet.FULL }) // Everything
// Custom features
const brain = new BrainyData({
const brain = new Brainy({
features: ['core', 'search', 'cache', 'triple-intelligence']
})
```
@ -274,14 +274,14 @@ When multiple Brainy instances connect to the same storage (like S3), you **must
import { ModelPrecision } from '@soulcraft/brainy'
// Container A - Writer
const writer = new BrainyData({
const writer = new Brainy({
mode: PresetName.WRITER,
model: ModelPrecision.FP32, // ⚠️ MUST match across instances!
storage: { s3Storage: { bucket: 'shared-data' }}
})
// Container B - Reader
const reader = new BrainyData({
const reader = new Brainy({
mode: PresetName.READER,
model: ModelPrecision.FP32, // ✅ Matches Container A
storage: { s3Storage: { bucket: 'shared-data' }}
@ -292,21 +292,21 @@ const reader = new BrainyData({
```typescript
// Ingestion Service (Writer)
const ingestion = new BrainyData({
const ingestion = new Brainy({
mode: PresetName.INGESTION_SERVICE,
model: ModelPrecision.Q8, // All instances must use Q8
storage: { s3Storage: { bucket: 'production-data' }}
})
// Search API (Reader)
const search = new BrainyData({
const search = new Brainy({
mode: PresetName.SEARCH_API,
model: ModelPrecision.Q8, // Matches ingestion service
storage: { s3Storage: { bucket: 'production-data' }}
})
// Analytics (Hybrid)
const analytics = new BrainyData({
const analytics = new Brainy({
mode: PresetName.ANALYTICS_SERVICE,
model: ModelPrecision.Q8, // Matches other services
storage: { s3Storage: { bucket: 'production-data' }}
@ -317,7 +317,7 @@ const analytics = new BrainyData({
### Before (Complex)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
hnsw: {
M: 16,
efConstruction: 200,
@ -350,7 +350,7 @@ const brain = new BrainyData({
### After (Simple)
```typescript
const brain = new BrainyData('production')
const brain = new Brainy('production')
// Everything above is auto-configured!
```

18
docs/api/COMPREHENSIVE_API_OVERVIEW.md
View file

@ -9,12 +9,12 @@
#### **1. Constructor & Initialization**
```typescript
// Clean, consistent initialization
const brain = new BrainyData(config?)
const brain = new Brainy(config?)
await brain.init() // Always required
// Storage auto-detection works seamlessly
const brain = new BrainyData({ storage: { forceMemoryStorage: true } })
const brain = new BrainyData({ storage: { path: './my-data' } })
const brain = new Brainy({ storage: { forceMemoryStorage: true } })
const brain = new Brainy({ storage: { path: './my-data' } })
```
#### **2. Data Operations (CRUD)**
@ -135,7 +135,7 @@ brain.storage.vacuum()
#### **1. Beginner Flow (Simple & Intuitive)**
```typescript
// Dead simple - just works
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
await brain.add('My first document', { nounType: NounType.Document })
@ -147,7 +147,7 @@ const groups = await brain.clusters()
#### **2. Intermediate Flow (More Control)**
```typescript
// Add configuration and options
const brain = new BrainyData({
const brain = new Brainy({
storage: { path: './my-brainy-db' },
neural: { cacheSize: 5000 }
})
@ -267,9 +267,9 @@ try {
### **✅ 4. Type Safety**
```typescript
// Excellent TypeScript support
import { BrainyData, NounType, VerbType } from '@soulcraft/brainy'
import { Brainy, NounType, VerbType } from '@soulcraft/brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.add('content', { nounType: NounType.Document, title: 'My Doc' })
// ^^^^^^^^^^^^^^^^ // IDE autocomplete!
```
@ -277,10 +277,10 @@ await brain.add('content', { nounType: NounType.Document, title: 'My Doc' })
### **✅ 5. Flexible Configuration**
```typescript
// Zero-config (just works)
const brain = new BrainyData()
const brain = new Brainy()
// Full control when needed
const brain = new BrainyData({
const brain = new Brainy({
storage: {
adapter: 'file',
path: './my-data',

10
docs/api/README.md
View file

@ -6,9 +6,9 @@
## Quick Start
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
const brain = new BrainyData() // Zero config!
const brain = new Brainy() // Zero config!
await brain.init()
// Add data (text auto-embeds!)
@ -248,7 +248,7 @@ Train the relationship scoring model:
#### Initialization
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: 'auto', // auto | memory | filesystem | s3
dimensions: 384, // Vector dimensions
cache: true, // Enable caching
@ -264,8 +264,8 @@ await brain.shutdown() // Graceful shutdown
```
#### Static Methods
- `BrainyData.preloadModel()` - Preload ML model
- `BrainyData.warmup()` - Warmup system
- `Brainy.preloadModel()` - Preload ML model
- `Brainy.warmup()` - Warmup system
---

4
docs/architecture/API_SURFACE_DESIGN.md
View file

@ -4,7 +4,7 @@
### **Main Class Shortcuts (Simple & Common)**
```typescript
// High-level shortcuts on BrainyData - most common operations
// High-level shortcuts on Brainy - most common operations
brain.similar(a, b, options?) // ✅ Keep - very common
brain.clusters(items?, options?) // ✅ Keep - very common
brain.related(id, options?) // ✅ Keep - common (like neighbors but simpler name)
@ -162,7 +162,7 @@ const streamingClusters = brain.neural.clusterStream({ batchSize: 50 })
### **High Priority:**
- [x] Create comprehensive type definitions
- [x] Implement improved NeuralAPI class with proper public/private separation
- [ ] Update BrainyData integration to use improved API
- [ ] Update Brainy integration to use improved API
- [ ] Fix brain-cloud explorer to use public APIs
- [ ] Update test files to use consistent method names
- [ ] Update documentation with new API structure

2
docs/architecture/augmentation-system-audit.md
View file

@ -37,7 +37,7 @@ brain.augmentations.register(augmentation)
### 4. Auto-Configuration ✅
```typescript
new BrainyData({
new Brainy({
cache: true, // Auto-registers CacheAugmentation
index: true, // Auto-registers IndexAugmentation
storage: 's3' // Auto-registers S3StorageAugmentation

4
docs/architecture/augmentations-actual.md
View file

@ -241,7 +241,7 @@ const cacheConfig = await getCacheAutoConfig()
### Enable Distributed Modes
```typescript
const brain = new BrainyData({
const brain = new Brainy({
mode: 'reader', // or 'writer' or 'hybrid'
distributed: {
role: 'reader',
@ -253,7 +253,7 @@ const brain = new BrainyData({
### Use Neural Import
```typescript
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new NeuralImportAugmentation({
confidenceThreshold: 0.7,

28
docs/architecture/augmentations.md
View file

@ -15,7 +15,7 @@ High-performance deduplication for streaming data ingestion.
```typescript
import { EntityRegistryAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new EntityRegistryAugmentation({
maxCacheSize: 100000, // Track up to 100k unique entities
@ -41,7 +41,7 @@ Enterprise-grade durability and crash recovery.
```typescript
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
checkpointInterval: 1000, // Checkpoint every 1000 operations
compression: true, // Enable log compression
@ -53,7 +53,7 @@ const brain = new BrainyData({
// All operations are now durably logged
// Recover from crash
const recovered = new BrainyData({
const recovered = new Brainy({
})
```
@ -71,7 +71,7 @@ AI-powered relationship strength calculation.
```typescript
import { IntelligentVerbScoringAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new IntelligentVerbScoringAugmentation({
factors: {
@ -111,7 +111,7 @@ Automatically extracts and registers entities from text.
```typescript
import { AutoRegisterEntitiesAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new AutoRegisterEntitiesAugmentation({
types: ['person', 'organization', 'location', 'product'],
@ -147,7 +147,7 @@ Optimizes bulk operations for maximum throughput.
```typescript
import { BatchProcessingAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new BatchProcessingAugmentation({
batchSize: 100,
@ -178,7 +178,7 @@ Intelligent multi-level caching system.
```typescript
import { CachingAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new CachingAugmentation({
levels: {
@ -211,7 +211,7 @@ Reduces storage size while maintaining query performance.
```typescript
import { CompressionAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new CompressionAugmentation({
algorithm: 'brotli',
@ -240,7 +240,7 @@ Real-time performance monitoring and metrics.
```typescript
import { MonitoringAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new MonitoringAugmentation({
metrics: ['operations', 'latency', 'cache', 'memory'],
@ -279,7 +279,7 @@ brain.on('metrics', (metrics) => {
```typescript
import { NeuralImportAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new NeuralImportAugmentation({
autoStructure: true,
@ -375,7 +375,7 @@ import { Augmentation } from 'brainy'
class CustomAugmentation extends Augmentation {
name = 'CustomAugmentation'
async onInit(brain: BrainyData): Promise<void> {
async onInit(brain: Brainy): Promise<void> {
// Initialize augmentation
console.log('Custom augmentation initialized')
}
@ -408,7 +408,7 @@ class CustomAugmentation extends Augmentation {
}
// Use custom augmentation
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [new CustomAugmentation()]
})
```
@ -420,7 +420,7 @@ const brain = new BrainyData({
```typescript
interface AugmentationHooks {
// Initialization
onInit(brain: BrainyData): Promise<void>
onInit(brain: Brainy): Promise<void>
onShutdown(): Promise<void>
// Noun operations
@ -459,7 +459,7 @@ interface AugmentationHooks {
```typescript
// Combine multiple augmentations
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
// Order matters - executed in sequence
new EntityRegistryAugmentation(), // Deduplication first

4
docs/architecture/noun-verb-taxonomy.md
View file

@ -41,8 +41,8 @@ const data = await brain1.export()
await brain2.import(data)
// Or sync between different storage backends
const cloudBrain = new BrainyData({ storage: 's3' })
const localBrain = new BrainyData({ storage: 'filesystem' })
const cloudBrain = new Brainy({ storage: 's3' })
const localBrain = new Brainy({ storage: 'filesystem' })
await cloudBrain.sync(localBrain) // Types match perfectly
```

6
docs/architecture/overview.md
View file

@ -4,7 +4,7 @@ Brainy is a multi-dimensional AI database that combines vector similarity, graph
## Core Components
### BrainyData (Main Entry Point)
### Brainy (Main Entry Point)
The central orchestrator that manages all subsystems:
- **HNSW Index**: O(log n) vector similarity search
- **Storage System**: Universal storage adapters (FileSystem, S3, OPFS, Memory)
@ -90,11 +90,11 @@ Brainy's extensible plugin architecture allows for powerful enhancements:
### Creating Custom Augmentations
```typescript
class CustomAugmentation extends BrainyAugmentation {
async onInit(brain: BrainyData): Promise<void> {
async onInit(brain: Brainy): Promise<void> {
// Initialize augmentation
}
async onAdd(item: any, brain: BrainyData): Promise<any> {
async onAdd(item: any, brain: Brainy): Promise<any> {
// Process item before adding
return item
}

14
docs/architecture/storage-architecture.md
View file

@ -27,7 +27,7 @@ Brainy provides multiple storage adapters with identical APIs:
### FileSystem Storage (Node.js)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'filesystem',
path: './data'
@ -40,7 +40,7 @@ const brain = new BrainyData({
### S3 Compatible Storage
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 's3',
bucket: 'my-brainy-data',
@ -58,7 +58,7 @@ const brain = new BrainyData({
### Origin Private File System (Browser)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'opfs'
}
@ -70,7 +70,7 @@ const brain = new BrainyData({
### Memory Storage
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'memory'
}
@ -172,7 +172,7 @@ Ensures durability and enables recovery:
### Caching Strategy
```typescript
// Configure caching per storage type
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'filesystem',
cache: {
@ -236,8 +236,8 @@ await brain.import(backup, {
### Storage Migration
```typescript
// Migrate between storage types
const oldBrain = new BrainyData({ storage: { type: 'filesystem' } })
const newBrain = new BrainyData({ storage: { type: 's3' } })
const oldBrain = new Brainy({ storage: { type: 'filesystem' } })
const newBrain = new Brainy({ storage: { type: 's3' } })
await oldBrain.init()
await newBrain.init()

10
docs/architecture/zero-config.md
View file

@ -11,10 +11,10 @@ Brainy is designed with **"Zero Config by Default, Infinite Tunability"** philos
### Instant Start
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
// That's it. No config needed.
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Brainy automatically:
@ -100,7 +100,7 @@ Brainy seamlessly migrates between storage types:
```typescript
// Start with memory storage (development)
const brain = new BrainyData() // Auto-selects memory
const brain = new Brainy() // Auto-selects memory
// Later, migrate to production storage
await brain.migrate({
@ -292,7 +292,7 @@ Models are automatically downloaded when needed:
```typescript
// First use - model auto-downloads
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // Downloads model if not cached
// Intelligent model caching
@ -705,7 +705,7 @@ While zero-config is default, you can override when needed:
```typescript
// Explicit configuration when needed
const brain = new BrainyData({
const brain = new Brainy({
// Override auto-detection
storage: {
type: 'filesystem',

24
docs/augmentations/COMPLETE-REFERENCE.md
View file

@ -5,9 +5,9 @@
## Quick Start
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
const brain = new BrainyData({
const brain = new Brainy({
// Augmentations auto-configure based on environment
storage: 'auto', // Storage augmentation
cache: true, // Cache augmentation
@ -40,7 +40,7 @@ Augmentations are modular extensions that add functionality to Brainy without cl
**Auto-enabled**: When `storage: 'memory'` or in test environments
**Purpose**: In-memory storage for testing and temporary data
```typescript
const brain = new BrainyData({ storage: 'memory' })
const brain = new Brainy({ storage: 'memory' })
```
### FileSystemStorageAugmentation
@ -48,7 +48,7 @@ const brain = new BrainyData({ storage: 'memory' })
**Auto-enabled**: When `storage: 'filesystem'` or Node.js detected
**Purpose**: Persistent file-based storage for Node.js applications
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: { type: 'filesystem', path: './data' }
})
```
@ -58,7 +58,7 @@ const brain = new BrainyData({
**Auto-enabled**: When `storage: 'opfs'` or browser with OPFS support
**Purpose**: Browser-based persistent storage using Origin Private File System
```typescript
const brain = new BrainyData({ storage: 'opfs' })
const brain = new Brainy({ storage: 'opfs' })
```
### S3StorageAugmentation
@ -66,7 +66,7 @@ const brain = new BrainyData({ storage: 'opfs' })
**Manual**: Requires AWS credentials
**Purpose**: AWS S3-compatible cloud storage
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 's3',
bucket: 'my-bucket',
@ -81,7 +81,7 @@ const brain = new BrainyData({
**Manual**: Requires Cloudflare credentials
**Purpose**: Cloudflare R2 storage (S3-compatible)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'r2',
accountId: 'xxx',
@ -96,7 +96,7 @@ const brain = new BrainyData({
**Manual**: Requires Google Cloud credentials
**Purpose**: Google Cloud Storage
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'gcs',
bucket: 'my-bucket',
@ -174,7 +174,7 @@ brain.addNouns([...]) // Automatically batched
**Auto-enabled**: When `wal: true`
**Purpose**: Write-ahead logging for crash recovery
```typescript
const brain = new BrainyData({ wal: true })
const brain = new Brainy({ wal: true })
// Automatic recovery on restart after crash
```
@ -275,7 +275,7 @@ class NotionSynapse extends SynapseAugmentation {
### Auto-Configuration
```typescript
const brain = new BrainyData({
const brain = new Brainy({
// These auto-register augmentations:
storage: 'auto', // Storage augmentation
cache: true, // Cache augmentation
@ -286,7 +286,7 @@ const brain = new BrainyData({
### Manual Registration
```typescript
const brain = new BrainyData()
const brain = new Brainy()
// Register before init()
const customAug = new MyCustomAugmentation()
@ -347,7 +347,7 @@ class MyAugmentation extends BaseAugmentation {
### Where Augmentations Hook In
**BrainyData Constructor**:
**Brainy Constructor**:
- Storage augmentations register based on config
- Cache/Index augmentations auto-register if enabled

4
docs/augmentations/CONFIGURATION.md
View file

@ -24,10 +24,10 @@ The Brainy Augmentation Configuration System provides a VSCode-style extension a
### Using an Augmentation with Configuration
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
// Zero-config (uses defaults)
const brain = new BrainyData()
const brain = new Brainy()
// With custom configuration
immediateWrites: true,

8
docs/augmentations/DEVELOPER-GUIDE.md
View file

@ -42,10 +42,10 @@ export class MyFirstAugmentation extends BaseAugmentation {
## Using Your Augmentation
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
import { MyFirstAugmentation } from './my-first-augmentation'
const brain = new BrainyData()
const brain = new Brainy()
// Register before init()
brain.augmentations.register(new MyFirstAugmentation())
@ -301,12 +301,12 @@ class EncryptionAugmentation extends BaseAugmentation {
```typescript
import { describe, it, expect } from 'vitest'
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
import { MyAugmentation } from './my-augmentation'
describe('MyAugmentation', () => {
it('should hook into addNoun', async () => {
const brain = new BrainyData({ storage: 'memory' })
const brain = new Brainy({ storage: 'memory' })
const aug = new MyAugmentation()
// Spy on the execute method

4
docs/augmentations/README.md
View file

@ -116,7 +116,7 @@ Visual representations of data.
### Zero-Config Approach
```typescript
const brain = new BrainyData()
const brain = new Brainy()
// Just register augmentations - they work automatically!
brain.augmentations.register(new EntityRegistryAugmentation())
@ -128,7 +128,7 @@ await brain.init()
### With Configuration
```typescript
const brain = new BrainyData()
const brain = new Brainy()
brain.augmentations.register(
new APIServerAugmentation({

8
docs/augmentations/api-server.md
View file

@ -33,10 +33,10 @@ npm install express cors ws
## Zero-Config Usage
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
import { APIServerAugmentation } from 'brainy/augmentations'
const brain = new BrainyData()
const brain = new Brainy()
// Register the API server augmentation
brain.augmentations.register(new APIServerAugmentation())
@ -281,7 +281,7 @@ The APIServerAugmentation hooks into Brainy's augmentation pipeline:
```typescript
// Server
const brain = new BrainyData()
const brain = new Brainy()
brain.augmentations.register(new APIServerAugmentation())
await brain.init()
@ -357,7 +357,7 @@ class FilteredAPIServer extends APIServerAugmentation {
### Integration with Other Augmentations
```typescript
const brain = new BrainyData()
const brain = new Brainy()
// Stack augmentations for complete system
brain.augmentations.register(new EntityRegistryAugmentation()) // Dedup

14
docs/features/complete-feature-list.md
View file

@ -137,7 +137,7 @@ await neuralImport.generateInsights(data)
Brainy automatically loads models with ZERO configuration required:
```typescript
const brain = new BrainyData() // That's it!
const brain = new Brainy() // That's it!
await brain.init()
// Models load automatically from best available source
```
@ -159,7 +159,7 @@ await brain.init()
### Reader Mode ✅
```typescript
const brain = new BrainyData({ mode: 'reader' })
const brain = new Brainy({ mode: 'reader' })
// Optimized for read-heavy workloads
// 80% cache ratio, aggressive prefetch
// 1 hour TTL, minimal writes
@ -167,7 +167,7 @@ const brain = new BrainyData({ mode: 'reader' })
### Writer Mode ✅
```typescript
const brain = new BrainyData({ mode: 'writer' })
const brain = new Brainy({ mode: 'writer' })
// Optimized for write-heavy workloads
// Large write buffers, batch writes
// Minimal caching, fast ingestion
@ -175,7 +175,7 @@ const brain = new BrainyData({ mode: 'writer' })
### Hybrid Mode ✅
```typescript
const brain = new BrainyData({ mode: 'hybrid' })
const brain = new Brainy({ mode: 'hybrid' })
// Balanced for mixed workloads
// Adaptive caching and batching
```
@ -346,7 +346,7 @@ import { crypto } from 'brainy/utils'
### 1. Zero Configuration
```typescript
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Everything else is automatic!
```
@ -384,10 +384,10 @@ await brain.init()
## 🚀 Quick Start
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
// Zero config required!
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Add data (auto-detects type)

26
docs/guides/enterprise-for-everyone.md
View file

@ -21,7 +21,7 @@ Enterprise features on our roadmap.
**Everyone gets bank-level security features:**
```typescript
const brain = new BrainyData({
const brain = new Brainy({
security: {
encryption: 'aes-256-gcm', // Military-grade encryption
keyRotation: true, // Automatic key rotation
@ -47,7 +47,7 @@ const brain = new BrainyData({
```typescript
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
enabled: true, // Write-ahead logging
redundancy: 3, // Triple redundancy
@ -102,7 +102,7 @@ const performance = {
```typescript
import { MonitoringAugmentation } from 'brainy'
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new MonitoringAugmentation({
metrics: 'all', // Complete metrics
@ -171,7 +171,7 @@ await brain.syncWith({
```typescript
// Same architecture Netflix uses, free for you
const brain = new BrainyData({
const brain = new Brainy({
clustering: {
enabled: true, // Distributed mode
sharding: 'automatic', // Auto-sharding
@ -197,7 +197,7 @@ const brain = new BrainyData({
**Everyone gets compliance tools:**
```typescript
const brain = new BrainyData({
const brain = new Brainy({
compliance: {
gdpr: {
rightToDelete: true, // Automatic PII deletion
@ -235,7 +235,7 @@ const brain = new BrainyData({
```typescript
// Advanced AI capabilities for everyone
const brain = new BrainyData({
const brain = new Brainy({
ai: {
embeddings: 'state-of-the-art', // Best models available
dimensions: 1536, // High-precision vectors
@ -267,7 +267,7 @@ const anomalies = await brain.detectAnomalies()
```typescript
// CI/CD and DevOps features
const brain = new BrainyData({
const brain = new Brainy({
operations: {
blueGreen: true, // Zero-downtime deployments
canary: true, // Gradual rollouts
@ -316,7 +316,7 @@ Your hobby project today might be tomorrow's unicorn startup. With Brainy, you w
### Startups
```typescript
// A 2-person startup gets the same features as Amazon
const startup = new BrainyData()
const startup = new Brainy()
// ✓ Full durability
// ✓ Complete security
// ✓ Unlimited scale
@ -326,7 +326,7 @@ const startup = new BrainyData()
### Education
```typescript
// Students learn with production-grade tools
const classroom = new BrainyData()
const classroom = new Brainy()
// ✓ No feature restrictions
// ✓ Real enterprise experience
// ✓ Free forever
@ -335,7 +335,7 @@ const classroom = new BrainyData()
### Non-Profits
```typescript
// NGOs get enterprise features without enterprise costs
const nonprofit = new BrainyData()
const nonprofit = new Brainy()
// ✓ Compliance tools
// ✓ Security features
// ✓ Scale for impact
@ -345,7 +345,7 @@ const nonprofit = new BrainyData()
### Enterprises
```typescript
// Enterprises get everything plus peace of mind
const enterprise = new BrainyData()
const enterprise = new Brainy()
// ✓ Proven at scale
// ✓ Community tested
// ✓ No vendor lock-in
@ -397,10 +397,10 @@ npm install brainy
```
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
// Create your enterprise-grade database
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// You're now running the same tech as Fortune 500 companies

20
docs/guides/getting-started.md
View file

@ -13,10 +13,10 @@ npm install @soulcraft/brainy
### Simple Initialization
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
// Create a new Brainy instance with defaults
const brain = new BrainyData()
const brain = new Brainy()
// Initialize (downloads models if needed)
await brain.init()
@ -27,7 +27,7 @@ await brain.init()
### Custom Configuration
```typescript
const brain = new BrainyData({
const brain = new Brainy({
// Storage configuration
storage: {
type: 'filesystem', // or 's3', 'opfs', 'memory'
@ -193,7 +193,7 @@ const results = await brain.find({
```typescript
// Configure for streaming
const brain = new BrainyData({
const brain = new Brainy({
augmentations: [
new EntityRegistryAugmentation(), // Deduplication
new BatchProcessingAugmentation({ batchSize: 100 }) // Batching
@ -220,7 +220,7 @@ async function processStream(item) {
### Development (Memory)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: { type: 'memory' }
})
// Fast, temporary, perfect for testing
@ -228,7 +228,7 @@ const brain = new BrainyData({
### Production (FileSystem)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 'filesystem',
path: '/var/lib/brainy'
@ -239,7 +239,7 @@ const brain = new BrainyData({
### Cloud (S3)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: {
type: 's3',
bucket: 'my-brainy-data',
@ -251,7 +251,7 @@ const brain = new BrainyData({
### Browser (OPFS)
```typescript
const brain = new BrainyData({
const brain = new Brainy({
storage: { type: 'opfs' }
})
// Browser-native, persistent, offline-capable
@ -279,7 +279,7 @@ for (const rel of relationships) {
### 2. Enable Caching
```typescript
const brain = new BrainyData({
const brain = new Brainy({
cache: {
enabled: true,
maxSize: 1000,
@ -298,7 +298,7 @@ const results = await brain.search("query", {
### 4. Index Frequently Queried Fields
```typescript
const brain = new BrainyData({
const brain = new Brainy({
indexedFields: ['category', 'userId', 'timestamp']
})
```

4
docs/guides/import-anything.md
View file

@ -9,9 +9,9 @@ Brainy's import is **ONE magical method** that understands EVERYTHING:
## The Ultimate Simplicity
```javascript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// ONE method for EVERYTHING:

24
docs/guides/model-loading.md
View file

@ -7,7 +7,7 @@ Brainy uses AI embedding models to understand and process your data. This guide
**For most developers, no configuration is needed:**
```typescript
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // Models load automatically
```
@ -38,21 +38,21 @@ Brainy tries multiple sources in this order:
### Browser
```typescript
// Automatically configured for browsers
const brain = new BrainyData() // Works in React, Vue, vanilla JS
const brain = new Brainy() // Works in React, Vue, vanilla JS
await brain.init() // Downloads models via CDN
```
### Node.js Development
```typescript
// Zero config - downloads to ./models/
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // Downloads once, cached forever
```
### Production Server
```typescript
// Preload models during build/deployment
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // Uses cached local models
```
@ -87,7 +87,7 @@ ls ./models/Xenova/all-MiniLM-L6-v2/
### Custom Model Path
```typescript
const brain = new BrainyData({
const brain = new Brainy({
embedding: {
cacheDir: './custom-models'
}
@ -213,7 +213,7 @@ chmod 755 ./models
export BRAINY_MODELS_PATH=/tmp/brainy-models
# Or use memory-only storage
const brain = new BrainyData({
const brain = new Brainy({
storage: { forceMemoryStorage: true }
})
```
@ -223,7 +223,7 @@ const brain = new BrainyData({
### Development
```typescript
// ✅ Zero config - just works
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
```
@ -259,7 +259,7 @@ RUN test -f ./models/Xenova/all-MiniLM-L6-v2/onnx/model.onnx
### Lambda/Serverless
```typescript
// ✅ Models in deployment package
const brain = new BrainyData({
const brain = new Brainy({
embedding: {
localFilesOnly: true, // No downloads in lambda
cacheDir: './models' // Bundled with deployment
@ -300,7 +300,7 @@ const response = await openai.embeddings.create({
})
// After: Local Brainy embeddings
const brain = new BrainyData()
const brain = new Brainy()
await brain.init() // One-time setup
const id = await brain.add("Your text", { nounType: 'content' }) // Embedded automatically
```
@ -312,7 +312,7 @@ from sentence_transformers import SentenceTransformer
model = SentenceTransformer('all-MiniLM-L6-v2')
# After: JavaScript Brainy (same model!)
const brain = new BrainyData() // Uses same all-MiniLM-L6-v2
const brain = new Brainy() // Uses same all-MiniLM-L6-v2
await brain.init()
```
@ -320,7 +320,7 @@ await brain.init()
### Custom Embedding Options
```typescript
const brain = new BrainyData({
const brain = new Brainy({
embedding: {
model: 'Xenova/all-MiniLM-L6-v2', // Default
dtype: 'q8', // Quantized for speed
@ -341,7 +341,7 @@ const customEmbedder = createEmbeddingFunction({
dtype: 'fp32' // Higher precision
})
const brain = new BrainyData({
const brain = new Brainy({
embeddingFunction: customEmbedder
})
```

4
docs/guides/natural-language.md
View file

@ -21,9 +21,9 @@ The current NLP implementation supports:
## Basic Usage
```typescript
import { BrainyData } from 'brainy'
import { Brainy } from 'brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Simply ask in natural language

6
docs/guides/neural-api.md
View file

@ -9,9 +9,9 @@ The Neural API provides advanced AI-powered features for understanding relations
## Quick Start
```javascript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
// Access Neural API
@ -340,7 +340,7 @@ const sim = await neural.similar('fake-id-1', 'fake-id-2')
```javascript
// Configure neural behavior at initialization
const brain = new BrainyData({
const brain = new Brainy({
neural: {
cacheSize: 1000, // Cache up to 1000 results
defaultAlgorithm: 'kmeans',

16
docs/troubleshooting.md
View file

@ -75,7 +75,7 @@ ENV BRAINY_MODEL_DTYPE=q8
chmod 755 ./brainy-data
# Use custom writable path
const brain = new BrainyData({
const brain = new Brainy({
storage: {
adapter: 'filesystem',
path: '/tmp/brainy-data'
@ -83,7 +83,7 @@ const brain = new BrainyData({
})
# Or use memory storage
const brain = new BrainyData({
const brain = new Brainy({
storage: { forceMemoryStorage: true }
})
```
@ -98,7 +98,7 @@ const brain = new BrainyData({
mkdir -p ./brainy-data
# Check storage configuration
const brain = new BrainyData({
const brain = new Brainy({
storage: {
adapter: 'filesystem',
path: '/full/path/to/storage' // Use absolute path
@ -126,7 +126,7 @@ const brain = new BrainyData({
2. **Network issues**
```typescript
// Set initialization timeout
const brain = new BrainyData()
const brain = new Brainy()
// Use Promise.race for timeout
const initPromise = Promise.race([
@ -210,7 +210,7 @@ const brain = new BrainyData({
1. **Enable search cache**
```typescript
const brain = new BrainyData({
const brain = new Brainy({
cache: {
search: {
maxSize: 1000,
@ -283,7 +283,7 @@ const brain = new BrainyData({
2. **Use memory storage in tests**
```typescript
// In test setup
const brain = new BrainyData({
const brain = new Brainy({
storage: { forceMemoryStorage: true }
})
```
@ -352,7 +352,7 @@ ENV BRAINY_MODELS_PATH=./models
Enable verbose logging to see what's happening:
```typescript
const brain = new BrainyData({
const brain = new Brainy({
logging: { verbose: true }
})
```
@ -364,7 +364,7 @@ Verify your Brainy setup:
```typescript
// Basic health check
try {
const brain = new BrainyData()
const brain = new Brainy()
await brain.init()
const id = await brain.add("health check", { nounType: 'content' })

8
docs/universal-display-augmentation.md
View file

@ -23,9 +23,9 @@ The Universal Display Augmentation is a powerful AI-powered system that automati
### Basic Usage
```typescript
import { BrainyData } from '@soulcraft/brainy'
import { Brainy } from '@soulcraft/brainy'
const brainy = new BrainyData()
const brainy = new Brainy()
await brainy.init()
// Add some data
@ -186,12 +186,12 @@ const stats = displayAug.getStats()
console.log(`Cache hit ratio: ${stats.cacheHitRatio}%`)
```
### BrainyData Configuration
### Brainy Configuration
Configure at initialization:
```typescript
const brainy = new BrainyData({
const brainy = new Brainy({
augmentations: {
display: {
enabled: true,