Skip to content

Commit 5e11f5b

Browse files
committed
docs(alloy): add README and mapping notes
1 parent e060a2c commit 5e11f5b

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

alloy/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Alloy Checks for GFQL F/B/F + WHERE
2+
3+
Purpose: bounded, mechanized equivalence checks between the GFQL path-spec and the set-based forward/backward/forward algorithm with WHERE lowerings.
4+
5+
## Model
6+
- Path semantics: bindings are sequences aligned to `seqSteps`; WHERE is per binding. Mirrors Python hop/chain construction.
7+
- Set semantics: executor-style F/B/F over per-alias node/edge sets; WHERE lowered via per-alias summaries.
8+
- Scopes: ≤8 Nodes, ≤8 Edges, ≤4 Steps, ≤4 Values. Null/NaN not modeled; hashing treated as prefilter and omitted.
9+
- Lowerings: inequalities via min/max summaries; equality via exact sets (bitsets modeled as sets).
10+
11+
## Commands
12+
- Default small checks (fast): `bash alloy/check_fbf_where.sh`
13+
- Full scopes (core + scenarios): `FULL=1 bash alloy/check_fbf_where.sh`
14+
- Add multi-chain full-scope: `FULL=1 MULTI=1 bash alloy/check_fbf_where.sh`
15+
16+
Env vars:
17+
- `ALLOY_IMAGE` (default `ghcr.io/graphistry/alloy6:6.2.0`)
18+
- `ALLOY_FALLBACK_IMAGE` (default `local/alloy6:latest`)
19+
- `ALLOY_PUSH=1` to push built image to ghcr when falling back.
20+
21+
## CI behavior
22+
- PR/push: small + scenario suite (faster).
23+
- schedule/workflow_dispatch: full scopes + optional multi-chain (heavier).
24+
- Job pre-pulls `ghcr.io/graphistry/alloy6:6.2.0`; falls back to local build and pushes when allowed.
25+
26+
## Notes / exclusions
27+
- Null/NaN semantics excluded; verified in Python/cuDF tests.
28+
- Hashing omitted; treat any hashing as sound prefilter, exactness rechecked in model.
29+
- Model uses set semantics for outputs (nodes/edges appearing on some satisfying path).

0 commit comments

Comments
 (0)