roboflow/supervision

Show Progress in time consuming tasks

Geschlossen

#183 geöffnet am 06.07.2023

Auf GitHub ansehenContributor Guide
 (31 Kommentare) (2 Reaktionen) (1 zugewiesene Person)Python (697 Forks)batch import
enhancementgood first issueversion 0.14.0version: 0.13.0

Repository-Metriken

Stars
 (9.234 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 13T 3h) (84 gemergte PRs in 30 T)

Beschreibung

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!

Contributor Guide

Research-Richtung
Überprüfe zunächst die Kommentare zum Issue, um Feedback der Maintainer oder spezifische Anforderungen zu verstehen. Identifiziere dann Funktionen in der Codebasis, die das Laden von Datensätzen, das Speichern von Bildern und die Videoverarbeitung behandeln (wahrscheinlich in Modulen wie dataset.py, io.py oder video.py). Füge tqdm Fortschrittsbalken zu Schleifen oder langlaufenden Operationen in diesen Funktionen hinzu. Stelle sicher, dass die Fortschrittsbalken nur angezeigt werden, wenn die Operationen in einem Kontext durchgeführt werden, in dem stdout verfügbar ist (z. B. nicht in einer Headless Umgebung). Teste die Änderungen schließlich mit großen Datensätzen, um zu bestätigen, dass die Fortschrittsbalken korrekt funktionieren.
Tech Stack
python
Domain
backend
Issue Type
Funktion
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.
Halber Tag
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
Pythontqdm
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75