Add status for Python Client Jobs by freddyaboulton · Pull Request #3645 · gradio-app/gradio

freddyaboulton · 2023-03-27T20:46:13Z

Description

Adds a method called status() to the Job class that returns the latest status from the backend. This status update has the following interface:

@dataclass
class StatusUpdate:
    """Update message sent from the worker thread to the Job on the main thread."""

    code: Status
    rank: int | None
    queue_size: int | None
    eta: float | None
    success: bool | None
    time: datetime | None

and the status is an enum with the following values

class Status(Enum):
    """Status codes presented to client users."""

    STARTING = "STARTING"
    JOINING_QUEUE = "JOINING_QUEUE"
    QUEUE_FULL = "QUEUE_FULL"
    IN_QUEUE = "IN_QUEUE"
    SENDING_DATA = "SENDING_DATA"
    START_ITERATION = "START_ITERATION"
    ITERATING = "ITERATING"
    FINISHED = "FINISHED"

For apps that are not queued, the status is manually set to be either ITERATING or FINISHED depending on the value of job.done().

Example running on stable diffusion space (outdated as it doesn't have the eta field):

Additional Modifications

The code snippet in the README for the python client was not working so I changed it
Modified the CI to install the local version of gradio_client
Modified format_backend and lint_backend to check the python client test directory

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

A note about the CHANGELOG

Hello 👋 and thank you for contributing to Gradio!

All pull requests must update the change log located in CHANGELOG.md, unless the pull request is labeled with the "no-changelog-update" label.

Please add a brief summary of the change to the Upcoming Release > Full Changelog section of the CHANGELOG.md file and include
a link to the PR (formatted in markdown) and a link to your github profile (if you like). For example, "* Added a cool new feature by [@myusername](link-to-your-github-profile) in [PR 11111](https://github.com/gradio-app/gradio/pull/11111)".

If you would like to elaborate on your change further, feel free to include a longer explanation in the other sections.
If you would like an image/gif/video showcasing your feature, it may be best to edit the CHANGELOG file using the
GitHub web UI since that lets you upload files directly via drag-and-drop.

gradio-pr-bot · 2023-03-27T20:54:40Z

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

freddyaboulton · 2023-03-28T02:37:19Z

+    QUEUE_FULL = "QUEUE_FULL"
+    IN_QUEUE = "IN_QUEUE"
+    SENDING_DATA = "SENDING_DATA"
+    START_ITERATION = "START_ITERATION"


Using the terms iteration and iterating to be consistent with generator functions. But maybe we can rename START_ITERATION to PROCESSING instead?

I prefer PROCESSING as well but either is fine

freddyaboulton · 2023-03-28T02:38:21Z

-        if len(self.dependency["outputs"]) == 1:
-            return outputs[0]
-        return outputs
+    def make_end_to_end_fn(self, queue: LifoQueue | None = None):


What I did here was make these functions into factory functions so that we can thread the queue all the way down

freddyaboulton · 2023-03-28T02:47:32Z

Still need to write docstrings and make some other minor changes but this is pretty stable now and would love to get comments on the api :)

abidlabs · 2023-03-28T21:23:56Z

@freddyaboulton and I synced on the internal implementation.

In terms of the user facing API, this looks good @freddyaboulton. Only one thing -- can we get an ETA back well? This could be useful if people are building something with the client and want to show an estimated ETA to the user

freddyaboulton · 2023-03-29T12:23:14Z

+    """
+
+    latest_status: StatusUpdate = field(default_factory=create_initial_status_update)
+    outputs: List[Any] = field(default_factory=list)


The outputs field is not used yet but I’m adding it here because we will need it for storing intermediate outputs of generators

freddyaboulton · 2023-03-29T12:24:47Z

@abidlabs simplified the implementation and added the eta to the StatusUpdate! Should be good for a proper review now.

abidlabs · 2023-03-29T15:34:42Z

LGTM @freddyaboulton this is awesome! The status() function works great in my tests, including when a client runs multiple jobs. You might want to add a test for that: having a client run multiple jobs in parallel and confirm that the statuses for each job appear correctly.

freddyaboulton · 2023-03-29T21:52:13Z

Thanks for the review @abidlabs ! Just added a test for the two concurrent jobs case. Will merge once CI passes.

abidlabs · 2023-03-29T21:59:19Z

@freddyaboulton do you know why this happens sometimes:

It says your tests have passed but it didn't even run the backend tests. Perhaps this related to tests queueing up?

freddyaboulton · 2023-03-29T22:04:58Z

Yea I think it's the queue build up @abidlabs !

…io into python-client-job-status

* Add status + unit test (flaky) for now * Install client * Fix tests * Lint backend + tests * Add non-queue test * Fix name * Use lock instead * Add simplify implementation + fix tests * Restore changes to scripts * Fix README typo * Fix CI * Add two concurrent test

* update gallery styles * Set theme name from load (#3595) * Add name + test * Add theme names * CHANGELOG * Delete theme in interface * Trigger event when Slider number input is released (#3589) * Add event * Add unit test * CHANGELOG * Sets up the Python `gradio` client (#3300) * placeholder * changelog * added to readme * client * implement futures * utils * scripts * lint * reorg * scripts * serialization * cleanup * fns * serialize * cache * callbacks * updates * formatting * packaging * requirements * remove changelog * client * access token * formatting * deprecate * format backend * client replace * updates * moving from utils * remove code duplication * rm duplicates * simplify * galleryserializer * serializable * load serializers * fixing errors * errors * typing * tests * changelog * lint * fix lint * fixing files * formatting * type * fix type checking * changelog * changelog * Update client/python/gradio_client/client.py Co-authored-by: Lucain <lucainp@gmail.com> * formatting, tests * formatting, tests * gr.load * refactoring * refactoring' * formatting * formatting * tests * tests * fix tests * cleanup * added tests * adding scripts * formatting * address review comments * readme * serialize info * remove from changelog * version 0.0.2 released * lint * type fix * check * type issues * hf_token * update hf token * telemetry * docs, circle dependency * hf token * formatting * updates * sort * script * external * docs * formatting * fixes * scripts * requirements * fix tests * context * changes * formatting * fixes * format fix --------- Co-authored-by: Lucain <lucainp@gmail.com> * Translate "or" for i18n (#3599) * Translate or for i18n * CHANGELOG * Fixes Blocks exit issue (#3600) * fix * changelog * blocks * formatting * Use gradio-api-server for telemetry (#3488) * analytics * changelog * remove interface analytics * ip * remove import * format * theme name * theme analytics * format * changelog * fixes * format * remove unused param --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Simplify tests (#3608) * simplify tests * imports * imports * formatting * removed cometml typing * simplify * changelog * fix wc error in dev mode (#3572) Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * A few small fixes to docs / demos (#3611) * fixes * remove binaries * doc * changelog * typing * run on windows * cancels * added clarifications * Add docs for HF Json saver (#3604) * Add docs for flagging * Fix params * CHANGELOG --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * ensure css loads before mounting app (#3573) * ensure css loads before mounting app * changelog * fix tests * change? * changelog * fix issue with missing version (#3632) Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Fixes chatbot autoscroll + Textbox lines > 20 issue (#3637) * fixes * changelog * Update gradio/components.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix embedded demos (#3638) Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Add Windows CI (#3628) * Add Windows CI * Update changelog * fix * Skip one test on Windows * Preserve virtualenv path * Skip another test on Windows * Make conditional flaky * Requested changes * consistent os * cleanup * fix test for windows * remove unnecessary check * lint * lint --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * move files (#3605) * move files * commit the rest of the files * fix lockfile * fix workflow * fix type errors * fix tests * only run ci when certain files change * run correct test command in ci * version * fix pypi script --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Support empty lists being used in `gr.Dataframe` (#3646) * Support empty lists being used in `gr.Dataframe` * Update changelog * Add empty dataframe test --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix windows flake (#3650) * fix windows flake * format backend --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Raise errror if event queued but queue is not enabled (#3640) * Raise Error * CHANGELOG * Add progress tracking validate_queue_settings * Update gradio/blocks.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix test --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Copy everything in website Dockerfile, fix build issues (#3659) * dockerfile * copy everything from repo * correct dir * changelog * Correct the documentation of `gr.File` component (#3660) This closes #3658. Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Nit in ValueError (#3669) * Nit in ValueError * CHANGELOG --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * Load upstream theme (#3641) * theme loading * upstream theme * version * format themes * fixes * tests * one more test * fix test * address review * Add job for python client ci (#3674) * Add job + lint * Fix path * Fix path * Fix path * Checkout * Add test requirements * Fix syntax * Fix test * Lint * Fix deps + README * Move dependency * Hide dropdown if in single-select mode (#3678) * Hide dropdown if in single-select mode * Update changelog --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix default parameters value and gr.Progress in same function (#3671) * Fix default parameters value and gr.Progress in same function * Update changelog * Fix tests * Format * Expand tests for other types of special function arguments * Augment SelectData tests --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * warning * changelog * ghangelog * changelog * object fit optional * Add status for Python Client Jobs (#3645) * Add status + unit test (flaky) for now * Install client * Fix tests * Lint backend + tests * Add non-queue test * Fix name * Use lock instead * Add simplify implementation + fix tests * Restore changes to scripts * Fix README typo * Fix CI * Add two concurrent test * Fix broken spaces in docs (#3698) * fix examples in sentence_builder * fix sklearn error in titanic demo * regenerate notebooks * changelgo * Add download button for video (#3581) * Add download buttom * Add missing imports * CHANGELOG * Update CHANGELOG.md * Trigger CI * Fix visibility * Try to fix ci * Fix deps * download button change * Lint --------- Co-authored-by: Dawood <dawoodkhan82@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix outdated sharing your app guide (#3699) * fix embed this space screenshot * fix use via api * changelog --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Add orig_name field to video outputs (#3700) * Add orig_name to video * Fix test * CHANGELOG * Lint * Theme builder (#3664) * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * Update CHANGELOG.md Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Update gradio/themes/builder.py Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes * changes --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * fix dropdowns, release 3.24 (#3713) * changes * changes * Update version.txt * New Version Docs (#3715) * [create-pull-request] automated change * fix changelog --------- Co-authored-by: abidlabs <abidlabs@users.noreply.github.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix chatbot newline issue (#3717) * changes * changes * changes * changelog --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * New Version Docs (#3720) * [create-pull-request] automated change * Trigger Build --------- Co-authored-by: aliabd <aliabd@users.noreply.github.com> Co-authored-by: aliabd <ali.si3luwa@gmail.com> * Fix Serializer Mapping (#3722) * Fix mapping and test * Bump gradio version * Revert gradio version bump * Fix some bugs related to Python client (#3721) * client format * docs * formatting * fix tests * fixed bug * api endpoint changes * fix tests * fix tests * formatting * Add support for sessions [python client] (#3731) * client * add state and tests * remove session param * node support for js client (#3692) * bundle js client + gen types * changeset * changeset * fix bugs * fix deps * fix deps * format * fix ci * fix types * Support IPv6 addresses for --server-name (#3695) * Support IPv6 addresses for --server-name * Update changelog now that I have a PR number. --------- Co-authored-by: freddyaboulton <alfonsoboulton@gmail.com> * Increase timeout for analytics request + remove exception print (#3647) * increase timeout * merge * Add changelog --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> * Switch linting to Ruff (#3710) * Sort requirements.in * Switch flake8 + isort to ruff * Apply ruff import order fixes * Fix ruff complaints in demo/ * Fix ruff complaints in test/ * Use `x is not y`, not `not x is y` * Remove unused listdir from website generator * Clean up duplicate dict keys * Add changelog entry * Clean up unused imports (except in gradio/__init__.py) * add space --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Fix missing docstrings (new PR) (#3740) * Move documentation for _js into docstring, not a stray comment * Add missing argument docstrings (and remove non-existent ones) * Add changelog entry * updated docstrings * changelog * contributors * changelog * formatting * removed _js --------- Co-authored-by: Aarni Koskela <akx@iki.fi> * import (#3742) * Import Literal from typing extensions in client (#3741) * Fix typing extensions * Import typing_extensions --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Access http token for ws connection (#3735) * Access unsecure token * CHANGELOG --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * Add root_url to serializers in gradio_client (#3736) * Add root_url to serializers * Add url fix * Respect fn parameter * Fix docstring * Add other test * Pass to method * CI tweaks (#3752) * Adds a pypi release action for the gradio python client (#3743) * release action * fixes * name * Update version.txt * Update version.txt * update * fixes * version * rename * action * fix token * custom dir * fixes * change password * revert back to token * scripts * remove twine * Get Intermediate Results from Python Client (#3694) * Add status + unit test (flaky) for now * Install client * Fix tests * Lint backend + tests * Add non-queue test * Fix name * Use lock instead * Add simplify implementation + fix tests * Restore changes to scripts * Fix README typo * Fix CI * Add intermediate results to python client * Type check * Typecheck again * Catch exception: * Thinking * Dont read generator from config * add no queue test * Remove unused method * Fix types * Remove breakpoint * Fix code * Fix test * Fix tests * Unpack list * Add docstring --------- Co-authored-by: Abubakar Abid <abubakar@huggingface.co> * changes (#3760) * Make Client Jobs Iterable (#3762) * Add iterator * Break if done * Add test for early termination * changelog * notebooks --------- Co-authored-by: Freddy Boulton <alfonsoboulton@gmail.com> Co-authored-by: Abubakar Abid <abubakar@huggingface.co> Co-authored-by: Lucain <lucainp@gmail.com> Co-authored-by: pngwn <hello@pngwn.io> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Ali Abdalla <ali.si3luwa@gmail.com> Co-authored-by: space-nuko <24979496+space-nuko@users.noreply.github.com> Co-authored-by: Luo Peng <luopeng.he@gmail.com> Co-authored-by: aliabid94 <aabid94@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: abidlabs <abidlabs@users.noreply.github.com> Co-authored-by: aliabd <aliabd@users.noreply.github.com> Co-authored-by: Dan Sully <dan+github@sully.org> Co-authored-by: Aarni Koskela <akx@iki.fi>

freddyaboulton added the no-changelog-update label Mar 27, 2023

freddyaboulton force-pushed the python-client-job-status branch from be8bcc2 to bfe00f3 Compare March 28, 2023 02:16

freddyaboulton commented Mar 28, 2023

View reviewed changes

freddyaboulton marked this pull request as ready for review March 28, 2023 02:44

freddyaboulton changed the title ~~WIP: Add status for Python Client Jobs~~ Add status for Python Client Jobs Mar 28, 2023

freddyaboulton requested review from abidlabs, aliabd, aliabid94, dawoodkhan82 and pngwn and removed request for abidlabs March 28, 2023 02:46

abidlabs reviewed Mar 28, 2023

View reviewed changes

Comment thread scripts/install_gradio.sh Outdated

abidlabs reviewed Mar 28, 2023

View reviewed changes

Comment thread client/python/README.md Outdated

freddyaboulton added 8 commits March 29, 2023 06:32

Add status + unit test (flaky) for now

ecb261e

Install client

7538ad6

Fix tests

9777ef2

Lint backend + tests

884aa9b

Add non-queue test

ae7cc45

Fix name

9676780

Use lock instead

7279e05

Add simplify implementation + fix tests

6f7daa9

freddyaboulton force-pushed the python-client-job-status branch from b1c0b4f to 6f7daa9 Compare March 29, 2023 11:25

freddyaboulton added 3 commits March 29, 2023 07:33

Restore changes to scripts

76b0140

Fix README typo

b575e3b

Fix CI

1351399

freddyaboulton commented Mar 29, 2023

View reviewed changes

freddyaboulton requested a review from abidlabs March 29, 2023 12:25

abidlabs approved these changes Mar 29, 2023

View reviewed changes

freddyaboulton mentioned this pull request Mar 29, 2023

Get Intermediate Results from Python Client #3694

Merged

7 tasks

freddyaboulton added 3 commits March 29, 2023 16:41

Merge branch 'main' into python-client-job-status

f941871

Add two concurrent test

09004bd

Merge branch 'main' into python-client-job-status

0398bd2

freddyaboulton added 3 commits March 29, 2023 18:13

Merge main

2c59c54

Merge branch 'python-client-job-status' of github.com:gradio-app/grad…

f799d7d

…io into python-client-job-status

Merge branch 'main' into python-client-job-status

86f8e9e

freddyaboulton merged commit f73155e into main Mar 29, 2023

freddyaboulton deleted the python-client-job-status branch March 29, 2023 22:41

Conversation

freddyaboulton commented Mar 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Additional Modifications

Checklist:

A note about the CHANGELOG

Uh oh!

gradio-pr-bot commented Mar 27, 2023

Uh oh!

freddyaboulton Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

abidlabs Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

freddyaboulton Mar 28, 2023

Choose a reason for hiding this comment

Uh oh!

freddyaboulton commented Mar 28, 2023

Uh oh!

Uh oh!

Uh oh!

abidlabs commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

freddyaboulton Mar 29, 2023

Choose a reason for hiding this comment

Uh oh!

freddyaboulton commented Mar 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abidlabs commented Mar 29, 2023

Uh oh!

freddyaboulton commented Mar 29, 2023

Uh oh!

abidlabs commented Mar 29, 2023

Uh oh!

freddyaboulton commented Mar 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

freddyaboulton commented Mar 27, 2023 •

edited

Loading

abidlabs Mar 29, 2023 •

edited

Loading

abidlabs commented Mar 28, 2023 •

edited

Loading

freddyaboulton commented Mar 29, 2023 •

edited

Loading