roboflow/supervision

Show Progress in time consuming tasks

Fermée

#183 ouverte le 6 juil. 2023

Voir sur GitHubGuide contributeur
 (31 commentaires) (2 réactions) (1 personne assignée)Python (697 forks)batch import
enhancementgood first issueversion 0.14.0version: 0.13.0

Métriques du dépôt

Stars
 (9 234 étoiles)
Métriques de merge PR
 (Merge moyen 13j 3h) (84 PRs mergées en 30 j)

Description

Search before asking

  • I have searched the Supervision issues and found no similar feature requests.

Description

It is highly suggestable that users have information on how process is going on especially on time consuming tasks such as dataset operations.

Example: Loading a large dataset can be time consuming. It can take a while to load whole dataset. Meanwhile users might be wondering if it is working properly or not. In worst situaiton, the process might even fails due to circumstances like memory issue or dataset issue.

Use case

  • Dataset ops
  • Image saving ops
  • Video processing ops

Additional

Solution:

Introducing Progressbar from tqdm can be very useful in such scenario.

Are you willing to submit a PR?

  • Yes I'd like to help by submitting a PR!

Guide contributeur

Direction de recherche
Tout d'abord, examinez les commentaires sur l'issue pour comprendre les retours des mainteneurs ou les exigences spécifiques. Ensuite, identifiez les fonctions dans la base de code qui gèrent le chargement des jeux de données, l'enregistrement des images et le traitement vidéo (probablement dans des modules comme dataset.py, io.py ou video.py). Ajoutez des barres de progression tqdm aux boucles ou aux opérations de longue durée dans ces fonctions. Assurez vous que les barres de progression ne s'affichent que lorsque les opérations sont effectuées dans un contexte où la sortie standard est disponible (par exemple, pas dans un environnement headless). Enfin, testez les modifications avec de grands jeux de données pour confirmer que les barres de progression fonctionnent correctement.
Stack technique
python
Domaine
backend
Type d'issue
Fonctionnalité
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.
Une demi journée
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
Pythontqdm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75