Andreas/docs

.gitignore

@@ -155,6 +155,14 @@ ml-20m/
 *.model
 *.mml
 nohup.out
+*.svg
+*.html
+*.js
+*.css
+*.tff
+*.woff
+*.woff2
+*.eot
 
 #####  kdd 2020 tutorial data folder
 examples/07_tutorials/KDD2020-tutorial/data_folder/
@@ -164,4 +172,4 @@ examples/07_tutorials/KDD2020-tutorial/data_folder/
 *.sh
 
 tests/**/resources/
-reports/
+reports/

CONTRIBUTING.md

@@ -23,7 +23,7 @@ Here are the basic steps to get started with your first contribution. Please rea
 5. Install development requirements. `pip install -r dev-requirements.txt`
 6. Create a test that replicates the issue.
 7. Make code changes.
-8. Ensure unit tests pass and code style / formatting is consistent (see [wiki](https://github.com/Microsoft/Recommenders/wiki/Coding-Guidelines#python-and-docstrings-style) for more details).
+8. Ensure that unit tests pass and code style / formatting is consistent (see [wiki](https://github.com/Microsoft/Recommenders/wiki/Coding-Guidelines#python-and-docstrings-style) for more details). In particular, make sure that there is a docstring for every function you add and that it conforms to the Google style. 
 9. Create a pull request against **staging** branch.
 
 Once the features included in a [milestone](https://github.com/microsoft/recommenders/milestones) are completed, we will merge staging into main. See the wiki for more detail about our [merge strategy](https://github.com/microsoft/recommenders/wiki/Strategy-to-merge-the-code-to-main-branch).

docs/README.md

@@ -13,4 +13,4 @@ To build the documentation as HTML:
     cd docs
     make html
 
-To contribute to this repository, please follow these [guidelines](https://github.com/Microsoft/Recommenders/wiki/Coding-Guidelines).
+To contribute to this repository, please follow these [guidelines](https://github.com/Microsoft/Recommenders/wiki/Coding-Guidelines). See also the [Sphinx documentation](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html) for the syntax of docstrings.

docs/source/dataset.rst

@@ -1,49 +1,66 @@
 .. _dataset:
 
 Dataset module
-**************************
+##############
 
-Recommendation datasets 
-===============================
+Recommendation datasets and related utilities
 
-.. automodule:: reco_utils.dataset.movielens
-    :members:
+Recommendation datasets 
+***********************
 
-.. automodule:: reco_utils.dataset.criteo
-    :members:
+Amazon Reviews
+==============
 
 .. automodule:: reco_utils.dataset.amazon_reviews
     :members:
 
+Azure COVID-19
+==============
+
 .. automodule:: reco_utils.dataset.covid_utils
     :members:
 
+Criteo
+======
+
+.. automodule:: reco_utils.dataset.criteo
+    :members:
+
+MIND
+====
+
 .. automodule:: reco_utils.dataset.mind
     :members:  
 
+MovieLens
+=========
+
+.. automodule:: reco_utils.dataset.movielens
+    :members:
+
 Download utilities 
-===============================
+******************
 
 .. automodule:: reco_utils.dataset.download_utils
     :members:
 
 
-Cosmos CLI 
-===============================
+Cosmos CLI utilities
+*********************
 
 .. automodule:: reco_utils.dataset.cosmos_cli
     :members:
 
 
-Pandas dataframe utils
-===============================
+Pandas dataframe utilities
+***************************
 
 .. automodule:: reco_utils.dataset.pandas_df_utils
     :members:
 
 
 Splitter utilities
-===============================
+******************
 
 .. automodule:: reco_utils.dataset.python_splitters
     :members:
@@ -56,14 +73,14 @@ Splitter utilities
 
 
 Sparse utilities
-===============================
+****************
 
 .. automodule:: reco_utils.dataset.sparse
     :members:
 
 
 Knowledge graph utilities
-===============================
+*************************
 
 .. automodule:: reco_utils.dataset.wikidata
     :members:

examples/01_prepare_data/mind_utils.ipynb

@@ -55,7 +55,7 @@
     "from tempfile import TemporaryDirectory\n",
     "from reco_utils.dataset.mind import (download_mind,\n",
     "                                     extract_mind,\n",
-    "                                     download_and_extract_globe,\n",
+    "                                     download_and_extract_glove,\n",
     "                                     load_glove_matrix,\n",
     "                                     word_tokenize\n",
     "                                    )\n",
@@ -326,7 +326,7 @@
     }
    ],
    "source": [
-    "glove_path = download_and_extract_globe(data_path)"
+    "glove_path = download_and_extract_glove(data_path)"
    ]
   },
   {