Dev/gfql endpoint

CHANGELOG.md

@@ -11,6 +11,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 * New tutorial on GPU memory management and capacity planning in the GPU section
 
+### Feat
+
+* `plot(render=)` supports literal-typed mode values: `"auto"`, `"g"`, `"url"`, `"ipython"`, `"databricks"`, where `"g"` is a new Plottable
+* Expose and track `._dataset_id`, `._url`, `._nodes_file_id`, and `._edges_file_id`
+* Upload: Factor out explicit upload method `g2 = g1.upload(); assert g2._dataset_id` from plot interface
+* bind: Remote dataset binding via `g1 = graphistry.bind(dataset_id='abc123')`
+* chain: Remote GFQL calls via `g2 = g1.chain_remote([...])` and `meta_df = g1.chain_remote_shape([...])`
+* python: Remote Python calls via `g2 = g1.python_remote(...)`
+
+### Changed
+
+* `plot(render=)` now `Union[bool, RenderMode]`, not just `bool` 
+
 ## [0.34.17 - 2024-10-20]
 
 ### Added

docs/source/gfql/about.rst

@@ -272,6 +272,30 @@ Use PyGraphistry's visualization capabilities to explore your graph.
 - Filters nodes where `pagerank > 0.1`.
 - Visualizes the subgraph consisting of high PageRank nodes.
 
+10. Run remotely
+
+You may want to run GFQL remotely because the data is remote or a GPU is available remotely:
+
+**Example: Run GFQL remotely**
+
+::
+
+    from graphistry import n, e
+    g2 = g1.chain_remote([n(), e(), n()])
+
+**Example: Run GFQL remotely, and decouple the upload step**
+
+::
+
+    from graphistry import n, e
+    g2 = g1.upload()
+    assert g2._dataset_id is not None, "Uploading sets `dataset_id` for subsequent calls"
+    g3 = g2.chain_remote([n(), e(), n()])
+
+
+Additional parameters enable controlling options such as the execution engine and what is returned 
+
+
 Conclusion and Next Steps
 -------------------------
 

docs/source/gfql/index.rst

@@ -13,6 +13,7 @@ See also:
 
    about
    overview
+   remote
    GFQL CPU & GPU Acceleration <performance>
    translate
    combo