microsoft/vasim

Add comments and docstrings

Ouverte

#6 ouverte le 30 août 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (1 personne assignée)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Métriques du dépôt

Stars
 (12 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Inspectez les modules recommender et simulator, comprenez la logique de formation de la fenêtre de données et ajoutez des docstrings et des commentaires pour clarifier le processus de prévision.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75