Merge pull request #440 from rapidsai/branch-23.02

Forward-merge branch-23.02 to branch-23.04
rapidsai · Jan 31, 2023 · 4021477 · 4021477
2 parents f1404bf + 0ffe93c
commit 4021477
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 deletions.
diff --git a/docs/_images/RAPIDS_cuxfilter.png b/docs/_images/RAPIDS_cuxfilter.png
diff --git a/docs/source/10_minutes_to_cuxfilter.ipynb b/docs/source/10_minutes_to_cuxfilter.ipynb
@@ -60,6 +60,24 @@
     "6. cuxfilter.assets"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Architecure\n",
+    "\n",
+    "The current version of cuxfilter leverages jupyter notebook and bokeh server to reduce architecture and installation complexity."
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![layout architecture](https://github.com/rapidsai/cuxfilter/raw/HEAD/docs/_images/RAPIDS_cuxfilter.png)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -930,7 +948,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.9.15 ('rapids-22.12')",
+   "display_name": "Python 3",
    "language": "python",
    "name": "python3"
   },
@@ -944,11 +962,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.8.10 (default, Nov 26 2021, 20:14:08) \n[GCC 9.3.0]"
   },
   "vscode": {
    "interpreter": {
-    "hash": "f6aa187a6aaade5733ad3b5ff5c82df04fb0b3dfac03c5ad044e20fb4c7093be"
+    "hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
    }
   }
  },

diff --git a/python/cuxfilter/dashboard.py b/python/cuxfilter/dashboard.py
@@ -106,6 +106,12 @@ class DashBoard:
         [0] Bokeh(Figure)
     [chart2] Column(sizing_mode='scale_both', width=1600)
         [0] Bokeh(Figure)`
+    >>> # d.app() for serving within notebook cell,
+    >>> # d.show() for serving as a separate web-app
+    >>> d.app() #or d.show()
+    displays interactive dashboard
+
+    do some visual querying/ crossfiltering
     """
 
     _charts: Dict[str, Union[CUXF_BASE_CHARTS]]
@@ -362,9 +368,10 @@ def export(self):
         >>>    [line_chart_1, line_chart_2],
         >>>    layout=cuxfilter.layouts.double_feature
         >>> )
+        >>> # d.app() for serving within notebook cell,
+        >>> # d.show() for serving as a separate web-app
         >>> d.app() #or d.show()
-        displays dashboard
-        do some visual querying/ crossfiltering
+        displays interactive dashboard
 
         >>> queried_df = d.export()
         final query 2<=key<=4