Forward `tqdm` constructor arguments to `Progress` component #4475

itrushkin · 2023-06-11T12:21:42Z

Description

Progress component with tqdm tracking enabled could not be rendered when no iterable is specified in tqdm initialization.

This PR forwards the total and unit keyword arguments that are used by Progress.tqdm method.

Example code

import gradio as gr
from tqdm import tqdm
import time

def test(s, _=gr.Progress(track_tqdm=True)):
    a = ''
    with tqdm(total=len(s)) as progress_bar:
        for c in s:
            a = c + a
            progress_bar.update()
            time.sleep(1)
    return a

demo = gr.Interface(test, 'text', 'text')
demo.queue().launch()

Render result

Version	Image
`main` branch
This PR

Checklist:

I have performed a self-review of my own code
I have added a short summary of my change to the CHANGELOG.md
My code follows the style guidelines of this project
I have commented my code in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com>

gradio-pr-bot · 2023-06-12T17:49:40Z

All the demos for this PR have been deployed at https://huggingface.co/spaces/gradio-pr-deploys/pr-4475-all-demos

abidlabs · 2023-06-12T18:01:38Z

gradio/helpers.py

@@ -546,15 +546,15 @@ def create_tracker(root_blocks, event_id, fn, track_tqdm):
    if not hasattr(root_blocks, "_progress_tracker_per_thread"):
        root_blocks._progress_tracker_per_thread = {}

-    def init_tqdm(self, iterable=None, desc=None, *args, **kwargs):
+    def init_tqdm(self, iterable=None, desc=None, total=None, unit='steps', *args, **kwargs):


Looks like the default value for unit in tqdm.tqdm is it:

Suggested change

def init_tqdm(self, iterable=None, desc=None, total=None, unit='steps', *args, **kwargs):

def init_tqdm(self, iterable=None, desc=None, total=None, unit='it', *args, **kwargs):

https://tqdm.github.io/docs/tqdm/

To keep the same behavior, I used the default gradio value for unit used in:

gradio/gradio/helpers.py

Line 480 in 06808df

unit: str = "steps",

Should I use tqdm value instead?

Hmm good point. @aliabid94 can you review this PR?

steps is better, this is what will be displayed in the frontend

abidlabs · 2023-06-12T18:04:32Z

Thanks @itrushkin for the nice PR. LGTM and can confirm it solves the original issue. Please see my comment above and in addition, two suggestions:

Can you please add a test to test/test_blocks to test this change?
Can you please run the formatter scripts (scripts/format_backend.sh) to format and lint the changes?

Should be good to merge then

shell11708 · 2023-06-14T00:49:38Z

Thanks a lot. To track the progress of hyperparameter tuning with optuna, I applied this PR and added tqdm.set_description wrapper in create_tracker function. Is there any possibility that set_description or set_postfix wrapper will also be added in gr.Progress?

abidlabs · 2023-06-15T17:31:08Z

Hi @itrushkin would you be interested in making the suggested changes?

abidlabs · 2023-06-21T20:03:44Z

Let us know once you have the test in place @itrushkin

abidlabs · 2023-06-26T13:50:30Z

I'll go ahead and make the changes above so that we can merge this in

gradio-pr-bot · 2023-06-26T13:57:01Z

All the demos for this PR have been deployed at https://huggingface.co/spaces/gradio-pr-deploys/pr-4475-all-demos

abidlabs · 2023-06-26T14:26:25Z

Merging, thanks again for the contribution @itrushkin

* Forward tqdm constructor arguments to Progress component Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com> * lint * reorder args * added tests --------- Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co>

* playwright tests for chatbot * more tests * changelog * Update CHANGELOG.md * fix upload file delay (#4661) * fix * changes * changes --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Forward `tqdm` constructor arguments to `Progress` component (#4475) * Forward tqdm constructor arguments to Progress component Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com> * lint * reorder args * added tests --------- Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Remove cleared_value (#4685) * Remove cleared_value * CHANGELOG * Add requirements.txt to dialogpt demo (#4686) * Add requirements.txt * Update demo notebook * Add torch * remove streaming demo + more tests * Fix blocks_kitchen_sink and streaming_stt demos (#4699) * Add code * Add json file * Remove streaming_stt demo * Undo generate_notebooks * Add blocks_kitchen_sink * fix tests * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * Update js/app/test/chatbot_multimodal.spec.ts Co-authored-by: pngwn <hello@pngwn.io> * update notebook * remove debug * remove debug --------- Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com> Co-authored-by: aliabid94 <aabid94@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: Ilya Trushkin <ilya.trushkin@intel.com> Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> Co-authored-by: pngwn <hello@pngwn.io>

itrushkin added 2 commits June 8, 2023 17:29

Forward tqdm constructor arguments to Progress component

f55ff3d

Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com>

Merge branch 'main' into progress_tqdm_forwarding_args

06808df

Signed-off-by: Ilya Trushkin <ilya.trushkin@intel.com>

abidlabs reviewed Jun 12, 2023

View reviewed changes

Merge branch 'main' into progress_tqdm_forwarding_args

e1cc0a6

abidlabs added 3 commits June 26, 2023 09:00

lint

39b60ee

reorder args

fc1e1ca

added tests

dc4c90d

abidlabs approved these changes Jun 26, 2023

View reviewed changes

abidlabs merged commit b5121a9 into gradio-app:main Jun 26, 2023
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Forward `tqdm` constructor arguments to `Progress` component #4475

Forward `tqdm` constructor arguments to `Progress` component #4475

itrushkin commented Jun 11, 2023

gradio-pr-bot commented Jun 12, 2023

abidlabs Jun 12, 2023

abidlabs Jun 12, 2023

itrushkin Jun 18, 2023

abidlabs Jun 20, 2023

aliabid94 Jun 21, 2023

abidlabs commented Jun 12, 2023

shell11708 commented Jun 14, 2023

abidlabs commented Jun 15, 2023

abidlabs commented Jun 21, 2023

abidlabs commented Jun 26, 2023

gradio-pr-bot commented Jun 26, 2023

abidlabs commented Jun 26, 2023

	def init_tqdm(self, iterable=None, desc=None, total=None, unit='steps', args, *kwargs):
	def init_tqdm(self, iterable=None, desc=None, total=None, unit='it', args, *kwargs):

Forward tqdm constructor arguments to Progress component #4475

Forward tqdm constructor arguments to Progress component #4475

Conversation

itrushkin commented Jun 11, 2023

Description

Example code

Render result

Checklist:

gradio-pr-bot commented Jun 12, 2023

abidlabs Jun 12, 2023

Choose a reason for hiding this comment

abidlabs Jun 12, 2023

Choose a reason for hiding this comment

itrushkin Jun 18, 2023

Choose a reason for hiding this comment

abidlabs Jun 20, 2023

Choose a reason for hiding this comment

aliabid94 Jun 21, 2023

Choose a reason for hiding this comment

abidlabs commented Jun 12, 2023

shell11708 commented Jun 14, 2023

abidlabs commented Jun 15, 2023

abidlabs commented Jun 21, 2023

abidlabs commented Jun 26, 2023

gradio-pr-bot commented Jun 26, 2023

abidlabs commented Jun 26, 2023

Forward `tqdm` constructor arguments to `Progress` component #4475

Forward `tqdm` constructor arguments to `Progress` component #4475