Skip to content

Commit 0683690

Browse files
lmeyerovclaude
andcommitted
docs(gfql): engines page — orient the cold newcomer (where does g come from)
§0 newcomer user-test: a first-timer landing on engines.rst cold hit the headline `g.gfql(query, engine='polars')` with no `g`/`query` defined (NameError on copy-paste); construction was buried (inside the coercion warning + the bottom install block) and there was no early pointer to getting-started. Add (1) an early "New to GFQL? build a graph first -> :doc:`about`" note, and (2) a 2-line self-contained preamble (graphistry.edges + a query) so the first example runs as-is. Reuses content already on the page; no restructure. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b6062da commit 0683690

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/source/gfql/engines.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ the engine with one keyword — ``engine=``, accepted uniformly by ``g.gfql()``
88
``g.hop()`` — and GFQL returns **identical results** on every one (differential parity
99
is a release gate). Pick the engine that fits your hardware and workload; nothing else changes.
1010

11+
.. note::
12+
**New to GFQL?** This page assumes you already have a graph ``g`` and a ``query``. If not,
13+
build one first — see :doc:`about` (10 Minutes to GFQL).
14+
1115
The one-line speedup
1216
--------------------
1317

@@ -16,6 +20,10 @@ engine is a one-keyword change — no GPU, same results:
1620

1721
.. code-block:: python
1822
23+
import graphistry
24+
g = graphistry.edges(df, 'src', 'dst') # df: your edges dataframe (pandas / Polars / cuDF)
25+
query = "MATCH (a)-[e]->(b) RETURN b" # any GFQL / Cypher query
26+
1927
g.gfql(query) # engine='pandas' (default)
2028
g.gfql(query, engine='polars') # up to ~38x faster on real graphs, no GPU, identical results
2129

0 commit comments

Comments
 (0)