Add performance benchmarks to user facing docs (#12595)

Resolves: #12295 This PR introduces a notebook of benchmarks that users will be able to run if they download the notebook. The notebook also generates graphs which are going to show up in cudf python docs. Authors: - GALI PREM SAGAR (https://github.com/galipremsagar) Approvers: - Bradley Dice (https://github.com/bdice) - Ray Douglass (https://github.com/raydouglass) URL: #12595
rapidsai · Mar 8, 2023 · 553162c · 553162c
1 parent 50f7e68
commit 553162c
Show file tree

Hide file tree

Showing 5 changed files with 1,652 additions and 1 deletion.
diff --git a/ci/test_notebooks.sh b/ci/test_notebooks.sh
@@ -34,7 +34,7 @@ pushd notebooks
 
 # Add notebooks that should be skipped here
 # (space-separated list of filenames without paths)
-SKIPNBS=""
+SKIPNBS="performance_comparisons.ipynb"
 
 EXITCODE=0
 trap "EXITCODE=1" ERR

diff --git a/docs/cudf/source/conf.py b/docs/cudf/source/conf.py
@@ -45,6 +45,8 @@
     "myst_nb",
 ]
 
+nb_execution_excludepatterns = ['performance-comparisons.ipynb']
+
 nb_execution_mode = "force"
 nb_execution_timeout = 300
 

diff --git a/docs/cudf/source/user_guide/index.md b/docs/cudf/source/user_guide/index.md
@@ -12,6 +12,7 @@ groupby
 guide-to-udfs
 cupy-interop
 options
+performance-comparisons
 PandasCompat
 copy-on-write
 ```