docs: revamp README.md with engaging descriptions and expand feature list
Enhanced the `README.md` with more engaging and user-friendly descriptions, highlighting Brainy's adaptability and intelligence. Introduced new sections detailing adaptive intelligence, data pipeline enhancements, and use case expansion. Removed outdated dependencies from `package-lock.json`. Updated `version.ts` to `0.7.2`.
This commit is contained in:
parent
3a9c424dc9
commit
633846e54a
3 changed files with 55 additions and 53 deletions
90
README.md
90
README.md
|
|
@ -12,24 +12,28 @@
|
||||||
|
|
||||||
## ✨ Overview
|
## ✨ Overview
|
||||||
|
|
||||||
Brainy combines the power of vector search with graph relationships in a lightweight, cross-platform database. Whether you're building AI applications, recommendation systems, or knowledge graphs, Brainy provides the tools you need to store, connect, and retrieve your data intelligently.
|
Say hello to Brainy, your new favorite data sidekick! 🎉 Brainy combines the power of vector search with graph relationships in a lightweight, cross-platform database that's as smart as it is fun to use. Whether you're building AI applications, recommendation systems, or knowledge graphs, Brainy provides the tools you need to store, connect, and retrieve your data intelligently.
|
||||||
|
|
||||||
|
What makes Brainy special? It intelligently adapts to you and your environment! Like a chameleon with a PhD, Brainy automatically detects your platform, adjusts its storage strategy, and optimizes performance based on your usage patterns. The more you use it, the smarter it gets - learning from your data to provide increasingly relevant results and connections.
|
||||||
|
|
||||||
### 🚀 Key Features
|
### 🚀 Key Features
|
||||||
|
|
||||||
- **Vector Search** - Find semantically similar content using embeddings
|
- **Vector Search** - Find semantically similar content using embeddings (like having ESP for your data!)
|
||||||
- **Graph Relationships** - Connect data with meaningful relationships
|
- **Graph Relationships** - Connect data with meaningful relationships (your data's social network)
|
||||||
- **Cross-Platform** - Works in browsers, Node.js, and server environments
|
- **Adaptive Intelligence** - Automatically optimizes for your environment and usage patterns
|
||||||
- **Persistent Storage** - Data persists across sessions
|
- **Cross-Platform** - Works everywhere you do: browsers, Node.js, and server environments
|
||||||
- **TypeScript Support** - Fully typed API with generics
|
- **Persistent Storage** - Data persists across sessions (no memory loss here!)
|
||||||
- **CLI Tools** - Powerful command-line interface for data management
|
- **TypeScript Support** - Fully typed API with generics (for those who like their code tidy)
|
||||||
|
- **CLI Tools** - Powerful command-line interface for data management (command line wizardry)
|
||||||
|
|
||||||
## 📊 What Can You Build?
|
## 📊 What Can You Build? (The Fun Stuff!)
|
||||||
|
|
||||||
- **Semantic Search Engines** - Find content based on meaning, not just keywords
|
- **Semantic Search Engines** - Find content based on meaning, not just keywords (mind-reading for your data!)
|
||||||
- **Recommendation Systems** - Suggest similar items based on vector similarity
|
- **Recommendation Systems** - Suggest similar items based on vector similarity (like a friend who really gets your taste)
|
||||||
- **Knowledge Graphs** - Build connected data structures with relationships
|
- **Knowledge Graphs** - Build connected data structures with relationships (your data's family tree)
|
||||||
- **AI Applications** - Store and retrieve embeddings for machine learning models
|
- **AI Applications** - Store and retrieve embeddings for machine learning models (brain food for your AI)
|
||||||
- **Data Organization Tools** - Automatically categorize and connect related information
|
- **Data Organization Tools** - Automatically categorize and connect related information (like having a librarian in your code)
|
||||||
|
- **Adaptive Experiences** - Create applications that learn and evolve with your users (digital chameleons!)
|
||||||
|
|
||||||
## 🔧 Installation
|
## 🔧 Installation
|
||||||
|
|
||||||
|
|
@ -71,51 +75,65 @@ await db.addVerb(catId, dogId, {
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🧩 How It Works
|
## 🧩 How It Works (The Magic Behind the Curtain)
|
||||||
|
|
||||||
Brainy combines three key technologies:
|
Brainy combines four key technologies to create its adaptive intelligence:
|
||||||
|
|
||||||
1. **Vector Embeddings** - Converts data (text, images, etc.) into numerical vectors that capture semantic meaning
|
1. **Vector Embeddings** - Converts data (text, images, etc.) into numerical vectors that capture semantic meaning (translating your data into brain-speak!)
|
||||||
2. **HNSW Algorithm** - Enables fast similarity search through a hierarchical graph structure
|
2. **HNSW Algorithm** - Enables fast similarity search through a hierarchical graph structure (like a super-efficient treasure map for your data)
|
||||||
3. **Persistent Storage** - Uses the best available storage option for your environment:
|
3. **Adaptive Environment Detection** - Automatically senses your platform and optimizes accordingly:
|
||||||
|
- Adjusts performance parameters based on available resources
|
||||||
|
- Learns from query patterns to optimize future searches
|
||||||
|
- Tunes itself for your specific use cases the more you use it
|
||||||
|
4. **Intelligent Storage Selection** - Uses the best available storage option for your environment:
|
||||||
- Browser: Origin Private File System (OPFS)
|
- Browser: Origin Private File System (OPFS)
|
||||||
- Node.js: File system
|
- Node.js: File system
|
||||||
- Server: S3-compatible storage (optional)
|
- Server: S3-compatible storage (optional)
|
||||||
- Fallback: In-memory storage
|
- Fallback: In-memory storage
|
||||||
|
- Automatically migrates between storage types as needed!
|
||||||
|
|
||||||
## 🚀 The Brainy Pipeline
|
## 🚀 The Brainy Pipeline (Data's Wild Ride!)
|
||||||
|
|
||||||
Brainy's data processing pipeline transforms raw data into searchable, connected knowledge. Here's how the magic happens:
|
Brainy's data processing pipeline transforms raw data into searchable, connected knowledge that gets smarter over time. Here's how the magic happens:
|
||||||
|
|
||||||
```
|
```
|
||||||
Raw Data → Embedding → Vector Storage → Graph Connections → Query & Retrieval
|
Raw Data → Embedding → Vector Storage → Graph Connections → Adaptive Learning → Query & Retrieval
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🔄 Pipeline Stages
|
Each time data flows through this pipeline, Brainy learns a little more about your usage patterns and environment, making future operations even faster and more relevant!
|
||||||
|
|
||||||
|
### 🔄 Pipeline Stages (The Journey of Your Data)
|
||||||
|
|
||||||
1. **Data Ingestion** 🍽️
|
1. **Data Ingestion** 🍽️
|
||||||
- Raw text or pre-computed vectors enter the pipeline
|
- Raw text or pre-computed vectors enter the pipeline (dinner time for data!)
|
||||||
- Data is validated and prepared for processing
|
- Data is validated and prepared for processing (washing hands before eating)
|
||||||
|
|
||||||
2. **Embedding Generation** 🧠
|
2. **Embedding Generation** 🧠
|
||||||
- Text is transformed into numerical vectors using embedding models
|
- Text is transformed into numerical vectors using embedding models (language → math magic)
|
||||||
- Choose between TensorFlow Universal Sentence Encoder (high quality) or Simple Embedding (faster)
|
- Choose between TensorFlow Universal Sentence Encoder (high quality) or Simple Embedding (faster)
|
||||||
- Custom embedding functions can be plugged in for specialized domains
|
- Custom embedding functions can be plugged in for specialized domains (bring your own secret sauce)
|
||||||
|
|
||||||
3. **Vector Indexing** 🔍
|
3. **Vector Indexing** 🔍
|
||||||
- Vectors are indexed using the HNSW algorithm
|
- Vectors are indexed using the HNSW algorithm (filing your data in the brain cabinet)
|
||||||
- Hierarchical structure enables lightning-fast similarity search
|
- Hierarchical structure enables lightning-fast similarity search (express lanes for your queries)
|
||||||
- Configurable parameters for precision vs. performance tradeoffs
|
- Configurable parameters for precision vs. performance tradeoffs (dial in your perfect balance)
|
||||||
|
|
||||||
4. **Graph Construction** 🕸️
|
4. **Graph Construction** 🕸️
|
||||||
- Nouns (entities) become nodes in the knowledge graph
|
- Nouns (entities) become nodes in the knowledge graph (data gets its own social network)
|
||||||
- Verbs (relationships) connect related entities
|
- Verbs (relationships) connect related entities (making friends and connections)
|
||||||
- Typed relationships add semantic meaning to connections
|
- Typed relationships add semantic meaning to connections (not just friends, but BFFs)
|
||||||
|
|
||||||
5. **Persistent Storage** 💾
|
5. **Adaptive Learning** 🌱
|
||||||
- Data is saved using the optimal storage for your environment
|
- Analyzes usage patterns to optimize future operations (gets to know your habits)
|
||||||
- Automatic selection between OPFS, filesystem, S3, or memory
|
- Tunes performance parameters based on your environment (adapts to your digital home)
|
||||||
- Configurable storage adapters for custom persistence needs
|
- Adjusts search strategies based on query history (learns what you're really looking for)
|
||||||
|
- Becomes more efficient and relevant the more you use it (like a good friendship)
|
||||||
|
|
||||||
|
6. **Intelligent Storage** 💾
|
||||||
|
- Data is saved using the optimal storage for your environment (finds the coziest home for your data)
|
||||||
|
- Automatic selection between OPFS, filesystem, S3, or memory (no manual configuration needed!)
|
||||||
|
- Migrates between storage types as your application's needs evolve (moves houses without you noticing)
|
||||||
|
- Configurable storage adapters for custom persistence needs (design your own dream data home)
|
||||||
|
|
||||||
### 🧩 Augmentation Types
|
### 🧩 Augmentation Types
|
||||||
|
|
||||||
|
|
|
||||||
16
package-lock.json
generated
16
package-lock.json
generated
|
|
@ -16,7 +16,6 @@
|
||||||
"@tensorflow/tfjs-backend-cpu": "^4.22.0",
|
"@tensorflow/tfjs-backend-cpu": "^4.22.0",
|
||||||
"@tensorflow/tfjs-core": "^4.22.0",
|
"@tensorflow/tfjs-core": "^4.22.0",
|
||||||
"@tensorflow/tfjs-layers": "^4.22.0",
|
"@tensorflow/tfjs-layers": "^4.22.0",
|
||||||
"ascii-tree": "^0.3.0",
|
|
||||||
"commander": "^14.0.0",
|
"commander": "^14.0.0",
|
||||||
"omelette": "^0.4.17",
|
"omelette": "^0.4.17",
|
||||||
"uuid": "^9.0.0"
|
"uuid": "^9.0.0"
|
||||||
|
|
@ -3462,15 +3461,6 @@
|
||||||
"node": ">=8"
|
"node": ">=8"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/ascii-tree": {
|
|
||||||
"version": "0.3.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/ascii-tree/-/ascii-tree-0.3.0.tgz",
|
|
||||||
"integrity": "sha512-eC3TvbRQLw+SY0HCVKPXv56JlZ6EeqLOIHT5oHGd0j98ngLDCjTEYbyHYHxrJcb4OwhqhiEo0zYr/FQpj1+Rpw==",
|
|
||||||
"license": "MIT",
|
|
||||||
"dependencies": {
|
|
||||||
"freetree": "0.2.2"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/async": {
|
"node_modules/async": {
|
||||||
"version": "3.2.6",
|
"version": "3.2.6",
|
||||||
"resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz",
|
"resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz",
|
||||||
|
|
@ -4616,12 +4606,6 @@
|
||||||
"node": ">= 6"
|
"node": ">= 6"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/freetree": {
|
|
||||||
"version": "0.2.2",
|
|
||||||
"resolved": "https://registry.npmjs.org/freetree/-/freetree-0.2.2.tgz",
|
|
||||||
"integrity": "sha512-bZ0U0Qv2THYrnkrD7B4UMAhWnDm3+va6y2mNfReke9HY7PRdvLgEf5Vl1j70P5KffoioFvV0RFRfIBQMWOLpIw==",
|
|
||||||
"license": "MIT"
|
|
||||||
},
|
|
||||||
"node_modules/fs.realpath": {
|
"node_modules/fs.realpath": {
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
|
||||||
|
|
|
||||||
|
|
@ -3,4 +3,4 @@
|
||||||
* Do not modify this file directly.
|
* Do not modify this file directly.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const VERSION = '0.7.1';
|
export const VERSION = '0.7.2';
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue