@soulcraft/brainy 0.9.5 → 0.9.7

package/README.md

@@ -6,7 +6,9 @@
 [![Node.js](https://img.shields.io/badge/node-%3E%3D23.11.0-brightgreen.svg)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.1.6-blue.svg)](https://www.typescriptlang.org/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
-[![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer)
+[![npm](https://img.shields.io/npm/v/@soulcraft/brainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
+
+[//]: # ([![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer))
 
 **A powerful graph & vector data platform for AI applications across any environment**
 
@@ -300,7 +302,7 @@ Brainy uses a modern build system that optimizes for both Node.js and browser en
     - `npm run build:browser`: Builds the browser-optimized version
     - `npm run build:all`: Builds both versions
     - `npm run demo`: Builds all versions and starts a demo server
-    - `npm run deploy:demo`: Deploys the examples directory to GitHub Pages
+    - GitHub Actions workflow: Automatically deploys the demo directory to GitHub Pages when pushing to the main branch
 
 ### Running the Pipeline
 
@@ -575,10 +577,10 @@ await db.deleteVerb(verbId)
 ### Embedding
 
 ```typescript
-import { 
-  BrainyData, 
-  createTensorFlowEmbeddingFunction, 
-  createThreadedEmbeddingFunction 
+import {
+  BrainyData,
+  createTensorFlowEmbeddingFunction,
+  createThreadedEmbeddingFunction
 } from '@soulcraft/brainy'
 
 // Use the standard TensorFlow Universal Sentence Encoder embedding function
@@ -599,7 +601,9 @@ await threadedDb.init()
 const vector = await db.embed("Some text to convert to a vector")
 ```
 
-The threaded embedding function runs in a separate thread (Web Worker in browsers, Worker Thread in Node.js) to improve performance, especially for CPU-intensive embedding operations. It automatically falls back to the main thread if threading is not available in the current environment.
+The threaded embedding function runs in a separate thread (Web Worker in browsers, Worker Thread in Node.js) to improve
+performance, especially for CPU-intensive embedding operations. It automatically falls back to the main thread if
+threading is not available in the current environment.
 
 ### Performance Tuning
 
@@ -1019,14 +1023,14 @@ the [Cloud Wrapper README](cloud-wrapper/README.md) for detailed configuration i
 
 The repository includes a comprehensive demo that showcases Brainy's main features:
 
-- `examples/demo.html` - A single demo page with animations demonstrating Brainy's features.
+- `demo/index.html` - A single demo page with animations demonstrating Brainy's features.
     - **[Try the live demo](https://soulcraft-research.github.io/brainy/demo/index.html)** - Check out the
       interactive demo on
       GitHub Pages
     - Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
-    - To deploy your own version to GitHub Pages, run `npm run deploy:demo`
-    - To deploy automatically when pushing to the main branch, a GitHub Actions workflow is included in
-      `.github/workflows/deploy-demo.yml`
+    - To deploy your own version to GitHub Pages, use the GitHub Actions workflow in
+      `.github/workflows/deploy-demo.yml`,
+      which automatically deploys when pushing to the main branch or can be manually triggered
     - To use a custom domain (like www.soulcraft.com):
         1. A CNAME file is already included in the demo directory
         2. In your GitHub repository settings, go to Pages > Custom domain and enter your domain
@@ -1216,7 +1220,19 @@ const id = await db.addToBoth('Deep learning is a subset of machine learning', {
 await db.shutDown()
 ```
 
-For a complete demonstration of Brainy's features, see the [demo page](index.html).
+---
+
+## 📈 Scaling Strategy
+
+Brainy is designed to handle datasets of various sizes, from small collections to large-scale deployments. For
+terabyte-scale data that can't fit entirely in memory, we provide several approaches:
+
+- **Disk-Based HNSW**: Modified implementations using intelligent caching and partial loading
+- **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.
 
 ## Requirements
 
@@ -1230,7 +1246,9 @@ We have a [Code of Conduct](CODE_OF_CONDUCT.md) that all contributors are expect
 
 ### Reporting Issues
 
-We use GitHub issues to track bugs and feature requests. Please use the provided issue templates when creating a new issue:
+We use GitHub issues to track bugs and feature requests. Please use the provided issue templates when creating a new
+issue:
+
 - [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md)
 - [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md)
 
@@ -1249,8 +1267,7 @@ Brainy follows a specific code style to maintain consistency throughout the code
 1. Fork the repository
 2. Create a feature branch
 3. Make your changes
-4. Run tests with `npm test`
-5. Submit a pull request
+4. Submit a pull request
 
 ## License