update api reference

PreferredAI · Nov 16, 2023 · 6d807e4 · 6d807e4
1 parent 228ec70
commit 6d807e4
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 79 deletions.
diff --git a/docs/source/api_ref/datasets.rst b/docs/source/api_ref/datasets.rst
@@ -6,52 +6,52 @@ Built-in Datasets
     :members:
 
 Amazon Clothing
------------------------------------------------
+---------------
 .. automodule:: cornac.datasets.amazon_clothing
    :members:
 
 Amazon Digital Music
------------------------------------------------
+--------------------
 .. automodule:: cornac.datasets.amazon_digital_music
    :members:
 
 Amazon Office
----------------------------------------------
+-------------
 .. automodule:: cornac.datasets.amazon_office
    :members:
 
 Amazon Toys and Games
----------------------------------------------
+---------------------
 .. automodule:: cornac.datasets.amazon_toy
    :members:
 
 CiteULike
------------------------------------------
+---------
 .. automodule:: cornac.datasets.citeulike
    :members:
 
 Epinions
------------------------------------------
+--------
 .. automodule:: cornac.datasets.epinions
    :members:
 
 FilmTrust
----------------------------------------------
+---------
 .. automodule:: cornac.datasets.filmtrust
    :members:
 
 MovieLens
------------------------------------------
+---------
 .. automodule:: cornac.datasets.movielens
    :members:
 
 Netflix
----------------------------------------
+-------
 .. automodule:: cornac.datasets.netflix
    :members:
 
 Tradesy
----------------------------------------
+-------
 .. automodule:: cornac.datasets.tradesy
    :members:
 
diff --git a/docs/source/api_ref/eval_methods.rst b/docs/source/api_ref/eval_methods.rst
@@ -1,29 +1,29 @@
 Evaluation Methods
-======================
+==================
 
 .. automodule:: cornac.eval_methods
 
 Base Method
------------------------------------------------
+-----------
 .. automodule:: cornac.eval_methods.base_method
    :members:
 
 Cross Validation
-----------------------------------------------------
+----------------
 .. automodule:: cornac.eval_methods.cross_validation
    :members:
 
 Propensity Stratified Evaluation
---------------------------------------------------------------------
+--------------------------------
 .. automodule:: cornac.eval_methods.propensity_stratified_evaluation
    :members:
 
 Ratio Split
------------------------------------------------
+-----------
 .. automodule:: cornac.eval_methods.ratio_split
    :members:
 
 Stratified Split
-----------------------------------------------------
+----------------
 .. automodule:: cornac.eval_methods.stratified_split
-   :members:
+   :members:
diff --git a/docs/source/api_ref/index.rst b/docs/source/api_ref/index.rst
@@ -1,7 +1,8 @@
 API Reference
 =============
 
-Welcome to the API Reference.
+Welcome to the API Reference. This section contains the documentation of the
+functions and classes of the ``cornac`` package.
 
 .. toctree::
    :maxdepth: 2
@@ -13,4 +14,4 @@ Welcome to the API Reference.
    eval_methods
    experiment
    datasets
-   hyperopt
+   hyperopt
diff --git a/docs/source/api_ref/metrics.rst b/docs/source/api_ref/metrics.rst
@@ -8,15 +8,15 @@ Rating
 ++++++
 
 Mean Absolute Error (MAE)
-----------------------------
+-------------------------
 .. autoclass:: MAE
 
 Mean Squared Error (MSE)
 ------------------------
 .. autoclass:: MSE
 
 Root Mean Squared Error (RMSE)
---------------------------------
+------------------------------
 .. autoclass:: RMSE
 
 +++++++
@@ -28,29 +28,29 @@ Area Under the Curve (AUC)
 .. autoclass:: AUC
 
 Fmeasure (F1)
--------------------
+-------------
 .. autoclass:: FMeasure
 
 Mean Average Precision (MAP)
 ----------------------------
 .. autoclass:: MAP
 
 Mean Reciprocal Rank (MRR)
--------------------------------------------
+--------------------------
 .. autoclass:: MRR
 
 Normalized Cumulative Reciprocal Rank (NCRR)
 --------------------------------------------
 .. autoclass:: NCRR
 
 Normalized Discount Cumulative Gain (NDCG)
--------------------------------------------
+------------------------------------------
 .. autoclass:: NDCG
 
 Precision
--------------------
+---------
 .. autoclass:: Precision
 
 Recall
--------------------
-.. autoclass:: Recall
+------
+.. autoclass:: Recall