Add all models tutorial links to docstrings

Offen
#110 10 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

@Saloni0512 arbeitet bereits daran.

Seit 24.3.2024.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python

Rechercherichtung

Read the model docstrings and the README examples, then identify which model algorithms need a short description and add score descriptions across the models. The issue gives ALS as an example but does not name files or tests; done means the relevant model docstrings explain their algorithms where needed and describe how their scores are calculated.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation good first issue
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

Vorherrschende Sprache
Python
Sterne
457
Forks
55
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus MTSWebServices/RecTools

Alle Issues in MTSWebServices/RecTools

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.