You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add short description of the algorithm if necessary (examples of such short descriptions can be found in our README)
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.
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.
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.
Activity
Saloni0512 commentedon Mar 24, 2024
Hi, I would like to work on this issue, if it's still incomplete.
blondered commentedon Mar 25, 2024
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.
Saloni0512 commentedon Mar 25, 2024
Okay sure!
Saloni0512 commentedon Mar 28, 2024
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.
blondered commentedon Mar 29, 2024
Scores descriptions are supposed to be added to models docstrings in each module
blondered commentedon May 14, 2024
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
Saloni0512 commentedon May 17, 2024
Okay sure, is there something else I can contribute to @blondered
blondered commentedon May 19, 2024
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?
Saloni0512 commentedon May 24, 2024
Yeah sure but under which issue will I work then I mean this one is closed so. @blondered
blondered commentedon May 24, 2024
Let's reopen it for this one for you.
[-]Add all models scores descriptions to docstrings[/-][+]Add all models tutorial links to docstrings[/+]