@soulcraft/brainy 0.9.6 → 0.9.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -6
- package/dist/utils/version.d.ts +1 -1
- package/package.json +2 -4
package/README.md
CHANGED
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
[](https://nodejs.org/)
|
|
7
7
|
[](https://www.typescriptlang.org/)
|
|
8
8
|
[](CONTRIBUTING.md)
|
|
9
|
-
[](https://www.npmjs.com/package/@soulcraft/brainy)
|
|
10
|
+
|
|
11
|
+
[//]: # ([](https://github.com/sodal-project/cartographer))
|
|
10
12
|
|
|
11
13
|
**A powerful graph & vector data platform for AI applications across any environment**
|
|
12
14
|
|
|
@@ -1026,7 +1028,8 @@ The repository includes a comprehensive demo that showcases Brainy's main featur
|
|
|
1026
1028
|
interactive demo on
|
|
1027
1029
|
GitHub Pages
|
|
1028
1030
|
- Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
|
|
1029
|
-
- To deploy your own version to GitHub Pages, use the GitHub Actions workflow in
|
|
1031
|
+
- To deploy your own version to GitHub Pages, use the GitHub Actions workflow in
|
|
1032
|
+
`.github/workflows/deploy-demo.yml`,
|
|
1030
1033
|
which automatically deploys when pushing to the main branch or can be manually triggered
|
|
1031
1034
|
- To use a custom domain (like www.soulcraft.com):
|
|
1032
1035
|
1. A CNAME file is already included in the demo directory
|
|
@@ -1221,13 +1224,15 @@ await db.shutDown()
|
|
|
1221
1224
|
|
|
1222
1225
|
## 📈 Scaling Strategy
|
|
1223
1226
|
|
|
1224
|
-
Brainy is designed to handle datasets of various sizes, from small collections to large-scale deployments. For
|
|
1227
|
+
Brainy is designed to handle datasets of various sizes, from small collections to large-scale deployments. For
|
|
1228
|
+
terabyte-scale data that can't fit entirely in memory, we provide several approaches:
|
|
1225
1229
|
|
|
1226
1230
|
- **Disk-Based HNSW**: Modified implementations using intelligent caching and partial loading
|
|
1227
1231
|
- **Distributed HNSW**: Sharding and partitioning across multiple machines
|
|
1228
1232
|
- **Hybrid Solutions**: Combining quantization techniques with multi-tier architectures
|
|
1229
1233
|
|
|
1230
|
-
For detailed information on how to scale Brainy for large datasets, see our
|
|
1234
|
+
For detailed information on how to scale Brainy for large datasets, see our
|
|
1235
|
+
comprehensive [Scaling Strategy](scalingStrategy.md) document.
|
|
1231
1236
|
|
|
1232
1237
|
## Requirements
|
|
1233
1238
|
|
|
@@ -1262,8 +1267,7 @@ Brainy follows a specific code style to maintain consistency throughout the code
|
|
|
1262
1267
|
1. Fork the repository
|
|
1263
1268
|
2. Create a feature branch
|
|
1264
1269
|
3. Make your changes
|
|
1265
|
-
4.
|
|
1266
|
-
5. Submit a pull request
|
|
1270
|
+
4. Submit a pull request
|
|
1267
1271
|
|
|
1268
1272
|
## License
|
|
1269
1273
|
|
package/dist/utils/version.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@soulcraft/brainy",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.9",
|
|
4
4
|
"description": "A vector graph database using HNSW indexing with Origin Private File System storage",
|
|
5
5
|
"main": "dist/unified.js",
|
|
6
6
|
"module": "dist/unified.js",
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
"start": "node dist/unified.js",
|
|
35
35
|
"demo": "npm run build && npm run build:browser && npx http-server -o /index.html",
|
|
36
36
|
"cli": "node ./cli-wrapper.js",
|
|
37
|
+
"version": "node scripts/generate-version.js",
|
|
37
38
|
"version:patch": "npm version patch",
|
|
38
39
|
"version:minor": "npm version minor",
|
|
39
40
|
"version:major": "npm version major",
|
|
@@ -85,17 +86,14 @@
|
|
|
85
86
|
"@rollup/plugin-node-resolve": "^15.2.3",
|
|
86
87
|
"@rollup/plugin-replace": "^5.0.5",
|
|
87
88
|
"@rollup/plugin-typescript": "^11.1.6",
|
|
88
|
-
"@types/jest": "^29.5.3",
|
|
89
89
|
"@types/node": "^20.4.5",
|
|
90
90
|
"@types/omelette": "^0.4.5",
|
|
91
91
|
"@types/uuid": "^10.0.0",
|
|
92
92
|
"@typescript-eslint/eslint-plugin": "^6.0.0",
|
|
93
93
|
"@typescript-eslint/parser": "^6.0.0",
|
|
94
94
|
"eslint": "^8.45.0",
|
|
95
|
-
"jest": "^29.6.2",
|
|
96
95
|
"rollup": "^4.12.0",
|
|
97
96
|
"rollup-plugin-terser": "^7.0.2",
|
|
98
|
-
"ts-jest": "^29.1.1",
|
|
99
97
|
"tslib": "^2.8.1",
|
|
100
98
|
"typescript": "^5.1.6"
|
|
101
99
|
},
|