@irongraph/cli-darwin-arm64 0.1.5 → 0.1.7
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 +19 -16
- package/THIRD_PARTY_NOTICES.txt +8902 -3
- package/bin/irongraph +2 -2
- package/bin/irongraph-mcp +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# IronGraph
|
|
2
2
|
|
|
3
|
-
**A
|
|
3
|
+
**A CPU graph database with built-in streaming and queues.**
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
Use Cypher to query graph structure, search text and vectors, inspect property history, and
|
|
6
|
+
administer the database. Built-in Kafka-compatible Streams and AMQP-compatible Queues handle event
|
|
7
|
+
and message workloads. The `irongraph` CLI starts and manages a standalone database with its
|
|
8
|
+
built-in web console. IronGraph is open-source software released under the Apache License 2.0.
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
## Performance at a glance
|
|
11
|
+
|
|
12
|
+
Graph queries execute on the CPU against one shared canonical graph. Local text inference can
|
|
13
|
+
use Metal or CUDA independently. Measure complete queries separately from individual graph operations;
|
|
14
|
+
latency depends on the workload, graph size, indexes, and host.
|
|
13
15
|
|
|
14
16
|
## Start the database and open the web console
|
|
15
17
|
|
|
@@ -44,8 +46,10 @@ npx irongraph logs
|
|
|
44
46
|
npx irongraph status
|
|
45
47
|
```
|
|
46
48
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
+
Graph execution uses the CPU. Text inference selects its device independently; on a supported
|
|
50
|
+
Mac, use `--embedding-backend metal`. On CPU-only hosts, including the published Linux packages,
|
|
51
|
+
start with `npx irongraph start --background --embedding-backend cpu`. Automatic inference selection
|
|
52
|
+
requires a supported accelerator. To run in the
|
|
49
53
|
foreground with live terminal output, use `npx irongraph start` without `--background`.
|
|
50
54
|
|
|
51
55
|
### 3. Open the web console
|
|
@@ -151,9 +155,9 @@ A project is an isolated graph with its own schema and indexes. `OBSERVED` holds
|
|
|
151
155
|
`KNOWLEDGE` holds curated facts, and `WORKSPACE` holds provisional working data. There is no
|
|
152
156
|
implicit default project.
|
|
153
157
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
158
|
+
Graph queries, algorithms, indexes, and vector retrieval use one shared CPU graph. Text inference
|
|
159
|
+
runs asynchronously on an independently selected CPU, Metal, or CUDA device. Parallel readers do
|
|
160
|
+
not wait for writers and may observe mixed values during a multi-record write.
|
|
157
161
|
|
|
158
162
|
## Choose your package
|
|
159
163
|
|
|
@@ -211,12 +215,11 @@ the example again to update and read the same text document. Next, declare an em
|
|
|
211
215
|
text property and use `MATCH … SEARCH … RETURN` to combine retrieval with graph context.
|
|
212
216
|
|
|
213
217
|
The example selects CPU so the same code works across native release targets, while automatic
|
|
214
|
-
text embedding stays enabled. Select `
|
|
218
|
+
text embedding stays enabled. Select `embedding_device="metal"` on a supported Mac to accelerate text inference.
|
|
215
219
|
|
|
216
220
|
## Deploy deliberately
|
|
217
221
|
|
|
218
|
-
Each database process
|
|
219
|
-
data and indexes do not fit; canonical graph data is never silently paged or truncated. One
|
|
222
|
+
Each database process uses one shared CPU graph and independently selects its text inference device. One
|
|
220
223
|
embedded instance owns its directory exclusively. Keep it open for your application's lifetime
|
|
221
224
|
and close it during orderly shutdown.
|
|
222
225
|
|