Skip to content

[FEATURE] Improve Cornac Documentation #646

Description

@darrylong

Description

Current status

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

  • Installation
  • Quickstart
  • For developers
  • For researchers

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation (Readme, readthedocs) related

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions