PreferredAI / cornac

A Comparative Framework for Multimodal Recommender Systems
https://cornac.preferred.ai
Apache License 2.0
888 stars 144 forks source link

[FEATURE] Improve Cornac Documentation #646

Open darrylong opened 1 month ago

darrylong commented 1 month ago

Description

Current status

Currently in readthedocs, we split our sections to 4 broad sections:

Explanation of proposed improvement

More could be done to further break these sections into smaller tutorials. For example, sections such as the following could be their own tutorials with a broader scope.

Further linkage and integration with existing tutorials on these 2 repository directories could be done for completeness as well.

Proposed Tutorial Structure

|- Installation |- Getting Started (Renamed from current Quickstart) |- Further Experiments (Focus on finetuning hyperparameters) |- Loading your Own Data |- Obtaining Recommendations |- Persisting a Trained Model |- Deploying as an API |-Model Types | |- Matrix factorization (Link to tutorial at https://github.com/PreferredAI/tutorials/blob/master/recommender-systems/03_matrix_factorization.ipynb) | |- Multimodality (Link to tutorial at https://github.com/PreferredAI/tutorials/blob/master/recommender-systems/05_multimodality.ipynb) | |- Explainability | |- Deep Learning | |- Ensemble Training |- Contributing | |- Link to some contribution tutorials at repo

Expected behavior with the suggested feature

Other Comments