Reviewing other rst

Signed-off-by: miguelgfierro <[email protected]>
recommenders-team · Jan 5, 2024 · ee60873 · ee60873
1 parent 9952f1c
commit ee60873
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 18 deletions.
diff --git a/docs/datasets.rst b/docs/datasets.rst
@@ -75,7 +75,6 @@ this impression. To protect user privacy, each user was de-linked from the produ
     and Ming Zhou, "MIND: A Large-scale Dataset for News Recommendation", ACL, 2020.
 
 
-
 .. automodule:: recommenders.datasets.mind
     :members:  
 
@@ -106,40 +105,41 @@ It comes with several sizes:
 
 Download utilities 
 ******************
-
 .. automodule:: recommenders.datasets.download_utils
     :members:
 
 
 Pandas dataframe utilities
 ***************************
-
 .. automodule:: recommenders.datasets.pandas_df_utils
     :members:
 
 
 Splitter utilities
 ******************
-
+Python splitters
+================
 .. automodule:: recommenders.datasets.python_splitters
     :members:
 
+PySpark splitters
+=================
 .. automodule:: recommenders.datasets.spark_splitters
     :members:
 
+Other splitters utilities
+=========================
 .. automodule:: recommenders.datasets.split_utils
     :members:
 
 
 Sparse utilities
 ****************
-
 .. automodule:: recommenders.datasets.sparse
     :members:
 
 
 Knowledge graph utilities
 *************************
-
 .. automodule:: recommenders.datasets.wikidata
     :members:
diff --git a/docs/evaluation.rst b/docs/evaluation.rst
@@ -13,4 +13,5 @@ PySpark evaluation
 ===============================
 
 .. automodule:: recommenders.evaluation.spark_evaluation
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/tuning.rst b/docs/tuning.rst
@@ -4,8 +4,8 @@ Hyperparameter tuning module
 *********************************
 Hyperparameter tuning module from Recommenders utilities.
 
+
 Parameter sweep utils
 ===============================
-
 .. automodule:: recommenders.tuning.parameter_sweep
     :members:
diff --git a/docs/utils.rst b/docs/utils.rst
@@ -6,65 +6,57 @@ Common utilities module
 
 General utilities
 ===============================
-
 .. automodule:: recommenders.utils.general_utils
     :members:
 
 
 GPU utilities
 ===============================
-
 .. automodule:: recommenders.utils.gpu_utils
     :members:
 
 
 Kubernetes utilities
 ===============================
-
 .. automodule:: recommenders.utils.k8s_utils
     :members:
 
 
 Notebook utilities
 ===============================
-
 .. automodule:: recommenders.utils.notebook_utils
     :members:
-
 .. automodule:: recommenders.utils.notebook_memory_management
     :members:
 
 
 Python utilities
 ===============================
-
 .. automodule:: recommenders.utils.python_utils
     :members:
 
 
 Spark utilities
 ===============================
-
 .. automodule:: recommenders.utils.spark_utils
     :members:
 
 
 Tensorflow utilities
 ===============================
-
 .. automodule:: recommenders.utils.tf_utils
     :members:
+    :special-members: __init__
 
 
 Timer
 ===============================
-
 .. automodule:: recommenders.utils.timer
     :members:
+    :special-members: __init__
 
 
 Plot utilities
 ===============================
-
 .. automodule:: recommenders.utils.plot
     :members: