Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to disable orange progress animation for generators #8543

Merged
merged 6 commits into from
Jun 12, 2024

Conversation

freddyaboulton
Copy link
Collaborator

Description

The orange animation is always displayed for a generator. You may want to disable this. For example, in a chatbot demo where the text stream is enough indication that progress is being made. In this PR, the orange animation is only shown for generators if show_progress='full'. Also added show_progress for Interface and ChatInterface.

I thought there was an issue for this but I can't find it.

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Tests

  1. PRs will only be merged if tests pass on CI. To run the tests locally, please set up your Gradio environment locally and run the tests: bash scripts/run_all_tests.sh

  2. You may need to run the linters: bash scripts/format_backend.sh and bash scripts/format_frontend.sh

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 12, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
Storybook ready! Storybook preview
🦄 Changes detected! Details

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/d16c5c4abdd502ce459845e32b58a01420c767ba/gradio-4.36.1-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@d16c5c4abdd502ce459845e32b58a01420c767ba#subdirectory=client/python"

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/d16c5c4abdd502ce459845e32b58a01420c767ba/gradio-client-1.1.1.tgz

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Jun 12, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/statustracker patch
gradio patch

With the following changelog entry.

Ability to disable orange progress animation for generators by setting show_progress='minimal' or show_progress='hidden' in the event definition. This is a small visual breaking change but it aligns better with the expected behavior of the show_progress parameter. Also added show_progress to gr.Interface and gr.ChatInterface.

⚠️ The changeset file for this pull request has been modified manually, so the changeset generation bot has been disabled. To go back into automatic mode, delete the changeset file.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

Copy link
Collaborator

@aliabid94 aliabid94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm thanks! technically a visual breaking change but pretty minor

@@ -732,6 +735,9 @@ async def cleanup():
batch=self.batch,
max_batch_size=self.max_batch_size,
concurrency_limit=self.concurrency_limit,
show_progress=cast(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is a cast necessary? isn't show_progress set to be of type Literal["full", "minimal", "hidden"]

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pyright infers it as str instead of the narrower Literal so it complains. I think it's because the property is set in init but it's being used in a separate method here.

@freddyaboulton freddyaboulton added v: patch A change that requires a patch release t: fix A change that implements a fix labels Jun 12, 2024
@freddyaboulton freddyaboulton marked this pull request as ready for review June 12, 2024 19:12
@freddyaboulton freddyaboulton enabled auto-merge (squash) June 12, 2024 19:12
@freddyaboulton freddyaboulton merged commit a4433be into main Jun 12, 2024
8 checks passed
@freddyaboulton freddyaboulton deleted the show-progress-for-generators branch June 12, 2024 19:46
@freddyaboulton
Copy link
Collaborator Author

Thanks for the review @aliabid94 !

@pngwn pngwn mentioned this pull request Jun 11, 2024
@pngwn pngwn mentioned this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t: fix A change that implements a fix v: patch A change that requires a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants