-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated cuxfilter docs to use the pydata theme and better follow newer docs conventions. Updated some copy. addresses #459 Authors: - Allan (https://github.com/exactlyallan) - Ajay Thorve (https://github.com/AjayThorve) Approvers: - Ajay Thorve (https://github.com/AjayThorve) - Ray Douglass (https://github.com/raydouglass) URL: #500
- Loading branch information
1 parent
01849f9
commit ea08be4
Showing
43 changed files
with
144 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions
2
docs/source/dataframe.rst → docs/source/api_reference/dataframe.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,18 @@ | ||
Welcome to cuxfilter's documentation! | ||
Welcome to cuxfilter's documentation | ||
===================================== | ||
|
||
cuxfilter acts as a connector library, which provides the connections between different visualization libraries and a GPU dataframe without much hassle. This also allows the user to use charts from different libraries in a single dashboard, while also providing the interaction. | ||
cuxfilter enables GPU accelerated cross-filtering dashboards from notebooks, in just a few lines of Python code. Well integrated with the HoloViz ecosystem, it also incorporates other outstanding visualization libraries. RAPIDS cuxfilter is ideal for multi-chart exploratory data analysis and dashboard prototyping within the RAPIDS ecosystem. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
|
||
./installation.rst | ||
./dataframe.rst | ||
./deployment.rst | ||
./10_minutes_to_cuxfilter.ipynb | ||
./Dask-cudf-support.rst | ||
./charts/charts.rst | ||
./layouts/Layouts.ipynb | ||
./themes/Themes.ipynb | ||
./examples/examples.rst | ||
user_guide/index | ||
api_reference/dataframe | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
Empty file.
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Charts | ||
====== | ||
|
||
cuxfilter is able to use a wide range of chart types: | ||
|
||
* Bokeh: line and bar | ||
* Datashader: high density line, stacked line, scatter, geospatial scatter, heatmap, and graph | ||
* DeckGL: webGL based geospatial 2D and 3D choropleth | ||
* Widgets: sliders, dropdowns, and cards | ||
* Custom: data table | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Contents: | ||
|
||
bokeh_charts.rst | ||
datashader_charts.rst | ||
deckgl_charts.rst | ||
widgets.rst | ||
custom_charts.rst |
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
docs/source/charts/panel_widgets.rst → docs/source/user_guide/charts/widgets.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
Panel Widgets | ||
Widgets | ||
============= | ||
|
||
.. currentmodule:: cuxfilter.charts | ||
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions
4
docs/source/examples/examples.rst → docs/source/user_guide/examples/index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Examples | ||
======== | ||
Example Dashboards | ||
================== | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
User Guide | ||
========== | ||
|
||
The user guide is intended as an overview of cuxfilter's capabilities as well as a showcase for examples. The best place to start is `10 Minutes to Cuxfilter`. For more advanced topics, see `Dask-cudf-support` for multi-GPU capabilities and `deployment` for exporting a dashboard for standalone usage outside of a notebook. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
installation | ||
10_minutes_to_cuxfilter | ||
charts/index | ||
layouts/Layouts | ||
themes/Themes | ||
examples/index | ||
Dask-cudf-support | ||
deployment |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 46 additions & 48 deletions
94
docs/source/layouts/Layouts.ipynb → docs/source/user_guide/layouts/Layouts.ipynb
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
36 changes: 11 additions & 25 deletions
36
docs/source/themes/Themes.ipynb → docs/source/user_guide/themes/Themes.ipynb
Large diffs are not rendered by default.
Oops, something went wrong.