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

**docs: remove outdated statistics-related documentation and add standards**

Browse source 
- **Removed Files**:
  - Deleted outdated statistics documentation files (`statistics.md`, `statistics-flush-solution.md`, `statistics-summary.md`) to clean up the repository and avoid confusion.

- **Added Standards**:
  - Introduced `DOCUMENTATION_STANDARDS.md` to outline naming conventions and troubleshooting practices for more consistent and maintainable project documentation.

- **Tests**:
  - Added a new test file `edge-cases.test.ts` to verify handling of edge cases, ensuring robust behavior against boundary values and invalid inputs.

**Purpose**: Cleans up deprecated documentation while introducing concrete standards for maintaining and updating documentation. Enhances test coverage for unusual or boundary inputs, improving overall system resilience.
This commit is contained in:
David Snelling 2025-07-28 16:00:05 -07:00
parent 3337c9f78e
commit 94c88e128c
41 changed files with 5583 additions and 498 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -494,7 +494,7 @@ const restoreResult = await db.restore(backupData, {clearExisting: true})
### Database Statistics
Brainy provides a way to get statistics about the current state of the database:
Brainy provides a way to get statistics about the current state of the database. For detailed information about the statistics system, including implementation details, scalability improvements, and usage examples, see our [Statistics Guide](STATISTICS.md).
```typescript
import {BrainyData, getStatistics} from '@soulcraft/brainy'
@ -503,22 +503,12 @@ import {BrainyData, getStatistics} from '@soulcraft/brainy'
const db = new BrainyData()
await db.init()
// Get statistics using the standalone function
const stats = await getStatistics(db)
// Get statistics using the instance method
const stats = await db.getStatistics()
console.log(stats)
// Output: { nounCount: 0, verbCount: 0, metadataCount: 0, hnswIndexSize: 0 }
// Or using the instance method
const instanceStats = await db.getStatistics()
// Output: { nounCount: 0, verbCount: 0, metadataCount: 0, hnswIndexSize: 0, serviceBreakdown: {...} }
```
The statistics include:
- `nounCount`: Number of nouns (entities) in the database
- `verbCount`: Number of verbs (relationships) in the database
- `metadataCount`: Number of metadata entries
- `hnswIndexSize`: Size of the HNSW index
### Working with Nouns (Entities)
```typescript
@ -1317,12 +1307,13 @@ terabyte-scale data that can't fit entirely in memory, we provide several approa
- **Distributed HNSW**: Sharding and partitioning across multiple machines
- **Hybrid Solutions**: Combining quantization techniques with multi-tier architectures
For detailed information on how to scale Brainy for large datasets, see our
comprehensive [Scaling Strategy](scalingStrategy.md) document.
For detailed information on how to scale Brainy for large datasets, vector dimension standardization, threading implementation, storage testing, and other technical topics, see our comprehensive [Technical Guides](TECHNICAL_GUIDES.md).
## Testing
Brainy uses Vitest for testing. The project includes several test scripts:
Brainy uses Vitest for testing. For detailed information about testing in Brainy, including test configuration, scripts, reporting tools, and best practices, see our [Testing Guide](TESTING.md).
Here are some common test commands:
```bash
# Run all tests
@ -1331,23 +1322,10 @@ npm test
# Run tests with comprehensive reporting
npm run test:report
# Run tests in watch mode
npm test:watch
# Run tests with UI
npm test:ui
# Run specific test suites
npm run test:node
npm run test:browser
npm run test:core
# Run tests with coverage
npm run test:coverage
```
The `test:report` script provides a comprehensive test report showing detailed information about all tests that were run, including test names, execution time, and pass/fail status.
## Contributing
For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).