Skip to content

Commit

Permalink
Change docs theme to pydata-sphinx theme (#4985)
Browse files Browse the repository at this point in the history
This PR:

- [x] Switches the python docs theme to `pydata-sphinx-theme` to be uniform with rest of the `rapids` python docs.
- [x] Fixes typos
- [x] Fixes a number of formatting and alignment issues in docstrings.
- [x] Discuss with cuml team on how(if any) and where things should be placed.

Authors:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - Corey J. Nolet (https://github.com/cjnolet)
  - AJ Schmidt (https://github.com/ajschmidt8)

URL: #4985
  • Loading branch information
galipremsagar authored Nov 17, 2022
1 parent c5ac66f commit dd197b9
Show file tree
Hide file tree
Showing 68 changed files with 377 additions and 637 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ _skbuild/

## files pickled in notebook when ran during python docstring generation
docs/source/*.model
docs/source/*.pkl
docs/source/*.tl

## eclipse
.project
Expand Down
18 changes: 0 additions & 18 deletions conda/environments/builddocs_py36.yml

This file was deleted.

30 changes: 0 additions & 30 deletions conda/environments/builddocs_py37.yml

This file was deleted.

2 changes: 1 addition & 1 deletion cpp/include/cuml/manifold/tsne.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ struct TSNEParams {
// The momentum used after the exaggeration phase.
float post_momentum = 0.8;

// Set this to -1 for pure random intializations or >= 0 for
// Set this to -1 for pure random initializations or >= 0 for
// reproducible outputs. This sets random seed correctly, but there
// may still be some variance due to the parallel nature of this algorithm.
long long random_state = -1;
Expand Down
42 changes: 0 additions & 42 deletions docs/source/_static/copybutton.css

This file was deleted.

61 changes: 0 additions & 61 deletions docs/source/_static/example_mod.js

This file was deleted.

87 changes: 0 additions & 87 deletions docs/source/_static/infoboxes.css

This file was deleted.

36 changes: 18 additions & 18 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
~~~~~~~~~~~~~~~~~~~
cuML API Reference
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~
API Reference
~~~~~~~~~~~~~

.. role:: py(code)
:language: python
Expand Down Expand Up @@ -187,7 +187,7 @@ Array Wrappers (Internal API)
:members:

Metrics (regression, classification, and distance)
---------------------------------------------------
--------------------------------------------------

.. automodule:: cuml.metrics.regression
:members:
Expand Down Expand Up @@ -239,7 +239,7 @@ Metrics (clustering and manifold learning)
:members:

Benchmarking
-------------
------------

.. automodule:: cuml.benchmark.algorithms
:members:
Expand Down Expand Up @@ -309,7 +309,7 @@ Multiclass Classification
:members:

Naive Bayes
----------------------
-----------

.. autoclass:: cuml.naive_bayes.MultinomialNB
:members:
Expand Down Expand Up @@ -399,13 +399,13 @@ Clustering
==========

K-Means Clustering
--------------------
------------------

.. autoclass:: cuml.KMeans
:members:

DBSCAN
-------
------

.. autoclass:: cuml.DBSCAN
:members:
Expand Down Expand Up @@ -446,7 +446,7 @@ Truncated SVD
:members:

UMAP
-------------
----

.. autoclass:: cuml.UMAP
:members:
Expand All @@ -464,7 +464,7 @@ Random Projections


TSNE
-------------
----

.. autoclass:: cuml.TSNE
:members:
Expand All @@ -485,22 +485,22 @@ Nearest Neighbors Classification
:members:

Nearest Neighbors Regression
--------------------------------
----------------------------

.. autoclass:: cuml.neighbors.KNeighborsRegressor
:members:

Kernel Density Estimation
--------------------------------
-------------------------

.. autoclass:: cuml.neighbors.KernelDensity
:members:

Time Series
============
===========

HoltWinters
-------------
-----------

.. autoclass:: cuml.ExponentialSmoothing
:members:
Expand Down Expand Up @@ -534,13 +534,13 @@ Multi-Node, Multi-GPU Algorithms
================================

DBSCAN Clustering
--------------------
-----------------

.. autoclass:: cuml.dask.cluster.DBSCAN
:members:

K-Means Clustering
--------------------
------------------

.. autoclass:: cuml.dask.cluster.KMeans
:members:
Expand All @@ -559,7 +559,7 @@ Nearest Neighbors


Principal Component Analysis
-----------------------------
----------------------------
.. autoclass:: cuml.dask.decomposition.PCA
:members:

Expand All @@ -573,7 +573,7 @@ Random Forest
:members:

Truncated SVD
--------------
-------------

.. autoclass:: cuml.dask.decomposition.TruncatedSVD
:members:
Expand Down
Loading

0 comments on commit dd197b9

Please sign in to comment.