**feat(core, migration, docs): introduce dimension mismatch resolution tools and migration guide**
- **Core**: - Added `check-database.js` to verify database status and validate search functionality. - Created `fix-dimension-mismatch.js` to handle re-embedding of existing data to resolve dimension mismatch from 3 to 512. - Improved test cases by updating vector operations to support 512 dimensions, replacing previously hardcoded dimensions. - **Migration**: - Developed `DIMENSION_MISMATCH_SUMMARY.md`, detailing the root cause, solution, and preventive strategies for dimension mismatch issues. - Added `production-migration-guide.md` for structured production migration with detailed steps on re-embedding strategies, batching, and error handling. - **Tests**: - Enhanced test coverage with 512-dimensional vector validation. - Introduced helper functions for consistent vector testing behavior and streamlined search test cases. - **Documentation**: - Updated project documentation to highlight the resolution process for dimension mismatches, emphasizing preventive mechanisms such as auto-migration and version tracking. **Purpose**: Address critical dimension mismatch issues caused by embedding changes, restore functionality, and provide a roadmap for robust prevention strategies and migration processes.
This commit is contained in:
parent
b2b50b71c0
commit
a010d3a92c
11 changed files with 814 additions and 141 deletions
|
|
@ -5,6 +5,17 @@
|
|||
|
||||
import { describe, it, expect, beforeAll } from 'vitest'
|
||||
|
||||
/**
|
||||
* Helper function to create a 512-dimensional vector for testing
|
||||
* @param primaryIndex The index to set to 1.0, all other indices will be 0.0
|
||||
* @returns A 512-dimensional vector with a single 1.0 value at the specified index
|
||||
*/
|
||||
function createTestVector(primaryIndex: number = 0): number[] {
|
||||
const vector = new Array(512).fill(0)
|
||||
vector[primaryIndex % 512] = 1.0
|
||||
return vector
|
||||
}
|
||||
|
||||
describe('Brainy Statistics Functionality', () => {
|
||||
let brainy: any
|
||||
|
||||
|
|
@ -24,7 +35,6 @@ describe('Brainy Statistics Functionality', () => {
|
|||
it('should retrieve statistics from a BrainyData instance', async () => {
|
||||
// Create a BrainyData instance
|
||||
const data = new brainy.BrainyData({
|
||||
dimensions: 3,
|
||||
metric: 'euclidean'
|
||||
})
|
||||
|
||||
|
|
@ -32,12 +42,12 @@ describe('Brainy Statistics Functionality', () => {
|
|||
await data.clear() // Clear any existing data
|
||||
|
||||
// Add some test data
|
||||
await data.add([1, 0, 0], { id: 'v1', label: 'x-axis' })
|
||||
await data.add([0, 1, 0], { id: 'v2', label: 'y-axis' })
|
||||
await data.add([0, 0, 1], { id: 'v3', label: 'z-axis' })
|
||||
await data.add(createTestVector(0), { id: 'v1', label: 'x-axis' })
|
||||
await data.add(createTestVector(1), { id: 'v2', label: 'y-axis' })
|
||||
await data.add(createTestVector(2), { id: 'v3', label: 'z-axis' })
|
||||
|
||||
// Add a verb
|
||||
await data.addVerb('v1', 'v2', [0.5, 0.5, 0], { type: 'connected_to' })
|
||||
await data.addVerb('v1', 'v2', createTestVector(3), { type: 'connected_to' })
|
||||
|
||||
// Get statistics using the standalone function
|
||||
const stats = await brainy.getStatistics(data)
|
||||
|
|
@ -56,14 +66,12 @@ describe('Brainy Statistics Functionality', () => {
|
|||
|
||||
it('should match the instance method results', async () => {
|
||||
// Create a BrainyData instance
|
||||
const data = new brainy.BrainyData({
|
||||
dimensions: 3
|
||||
})
|
||||
const data = new brainy.BrainyData({})
|
||||
|
||||
await data.init()
|
||||
|
||||
// Add some test data
|
||||
await data.add([1, 1, 1], { id: 'test1' })
|
||||
await data.add(createTestVector(5), { id: 'test1' })
|
||||
|
||||
// Get statistics using both methods
|
||||
const instanceStats = await data.getStatistics()
|
||||
|
|
@ -76,7 +84,6 @@ describe('Brainy Statistics Functionality', () => {
|
|||
it('should track statistics by service', async () => {
|
||||
// Create a BrainyData instance
|
||||
const data = new brainy.BrainyData({
|
||||
dimensions: 3,
|
||||
metric: 'euclidean'
|
||||
})
|
||||
|
||||
|
|
@ -84,9 +91,9 @@ describe('Brainy Statistics Functionality', () => {
|
|||
await data.clear() // Clear any existing data
|
||||
|
||||
// Add data from different services
|
||||
await data.add([1, 0, 0], { id: 'v1', label: 'service1-item' }, { service: 'service1' })
|
||||
await data.add([0, 1, 0], { id: 'v2', label: 'service1-item' }, { service: 'service1' })
|
||||
await data.add([0, 0, 1], { id: 'v3', label: 'service2-item' }, { service: 'service2' })
|
||||
await data.add(createTestVector(10), { id: 'v1', label: 'service1-item' }, { service: 'service1' })
|
||||
await data.add(createTestVector(20), { id: 'v2', label: 'service1-item' }, { service: 'service1' })
|
||||
await data.add(createTestVector(30), { id: 'v3', label: 'service2-item' }, { service: 'service2' })
|
||||
|
||||
// Add verbs from different services
|
||||
await data.addVerb('v1', 'v2', undefined, { type: 'related_to', service: 'service1' })
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue