Skip to content

Add all models tutorial links to docstrings #110

Open

Description

@blondered

Feature Description

Extend models docstrings in the following way:

  1. Add short description of the algorithm if necessary (examples of such short descriptions can be found in our README)
  2. Add description to scores. For example, for ALS model it could be something like: Model scores are dot products of learnt user embedding and recommended item embeddings for user-to-item recommendations. For item-to-item recommendations scores are cosine similarities between target item embedding and recommended item embeddings.

Why this feature?

Helpful for new users

Additional context

No response

Activity

  1. moved this to 📋 Backlog in RecTools boardon Feb 26, 2024
  2. Saloni0512 commented on Mar 24, 2024

    @Saloni0512

    Hi, I would like to work on this issue, if it's still incomplete.

  3. blondered commented on Mar 25, 2024

    @blondered
    CollaboratorAuthor

    Hello! Sure, thanks.
    I've extended description of this issue.
    You can start from one model and open a draft PR with it. This way we can make sure that the form is right. And then you can continue to do descriptions to all of the models.

  4. Saloni0512 commented on Mar 25, 2024

    @Saloni0512

    Okay sure!

  5. Saloni0512 commented on Mar 28, 2024

    @Saloni0512

    Hi, I wanted to ask that in which file I am supposed to add the model scores . In the docs folder, there is a models.rst file and model_selection.rst file. Which one is supposed to have the required documentation.

  6. blondered commented on Mar 29, 2024

    @blondered
    CollaboratorAuthor

    Scores descriptions are supposed to be added to models docstrings in each module

  7. blondered commented on May 14, 2024

    @blondered
    CollaboratorAuthor

    I think, we are closing it since we are moving all this info to Extended Tutorial on RecSys Baselines. So it it now a duplicate

  8. moved this from 📋 Backlog to ✅ Done in RecTools boardon May 14, 2024
  9. Saloni0512 commented on May 17, 2024

    @Saloni0512

    Okay sure, is there something else I can contribute to @blondered

  10. blondered commented on May 19, 2024

    @blondered
    CollaboratorAuthor

    If you still want the same kind of issue (contributing to documentation) you can add links from each model class docstring to this model in our "Extended baselines tutorial": https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html
    Correct links for each model can be found on this page: https://rectools.readthedocs.io/en/latest/tutorials.html

    It this ok for you?

  11. Saloni0512 commented on May 24, 2024

    @Saloni0512

    Yeah sure but under which issue will I work then I mean this one is closed so. @blondered

  12. blondered commented on May 24, 2024

    @blondered
    CollaboratorAuthor

    Let's reopen it for this one for you.

  13. moved this from ✅ Done to 📋 Backlog in RecTools boardon May 24, 2024
  14. changed the title [-]Add all models scores descriptions to docstrings[/-] [+]Add all models tutorial links to docstrings[/+] on May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions