Updated docs

rmj3197 · May 30, 2024 · 6444c65 · 6444c65
1 parent 1524e22
commit 6444c65
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 14 deletions.
diff --git a/QuadratiK/spherical_clustering/_pkbc.py b/QuadratiK/spherical_clustering/_pkbc.py
@@ -78,12 +78,12 @@ class PKBC:
 
 
         labels\\_ : dict
-            Final cluster membership assigned by the algorithm to each observation
+            Final cluster membership assigned by the algorithm to each observation.
             A dictionary containing key-value pairs, where each key is an element from the `num_clust` vector,
             and each value is a numpy.ndarray of shape (n_samples,)
 
         log_lik_vecs\\_ : dict
-            Array of log-likelihood values for each initialization
+            Array of log-likelihood values for each initialization.
             A dictionary containing key-value pairs, where each key is an element from the `num_clust` vector,
             and each value is a numpy.ndarray of shape (num_init, )
 

diff --git a/doc/source/user_guide/datasets.rst b/doc/source/user_guide/datasets.rst
@@ -1,16 +1,9 @@
 .. _datasets:
 
-Wireless Localization Dataset
------------------------------
+===========
+Datasets
+===========
 
 .. include:: ../../../QuadratiK/datasets/data/wireless_localization_dataset.rst
-
-Wisconsin Breast Cancer Dataset
--------------------------------
-
 .. include:: ../../../QuadratiK/datasets/data/wisconsin_breast_cancer_dataset.rst
-
-Wine Dataset
-------------
-
 .. include:: ../../../QuadratiK/datasets/data/wine_dataset.rst
diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
@@ -8,10 +8,16 @@ Dataset
 
    datasets.rst
 
-Usage Examples
----------------
+Common Usage Examples
+-----------------------
 .. toctree::
    :maxdepth: 4
 
    basic_usage
+
+Random Sampling from PKBD
+---------------------------
+.. toctree::
+   :maxdepth: 4
+
    gen_plot_rpkb