Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Improve Cornac Documentation #646

Open
darrylong opened this issue Oct 14, 2024 · 0 comments
Open

[FEATURE] Improve Cornac Documentation #646

darrylong opened this issue Oct 14, 2024 · 0 comments
Labels
docs Documentation (Readme, readthedocs) related

Comments

@darrylong
Copy link
Member

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

@darrylong darrylong added the docs Documentation (Readme, readthedocs) related label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation (Readme, readthedocs) related
Projects
None yet
Development

No branches or pull requests

1 participant