microsoft/vasim

Add comments and docstrings

Offen

#6 geöffnet am 30.08.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (7 Forks)auto 404
TODOdocumentationhelp wanted

Repository-Metriken

Stars
 (12 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We especially need comments/docs in recommender and simulator. A lot of these can be autogenerated and then heavily edited.

I think we need to especially clarify the way the data window is formed in the predictive forecasting, etc.

### Tasks
- [ ] https://github.com/microsoft/vasim/issues/61

Contributor Guide

Research-Richtung
Prüfen Sie die Module recommender und simulator, verstehen Sie die Logik der Datenfensterbildung und fügen Sie Docstrings und Kommentare hinzu, um den Vorhersageprozess zu klären.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75