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

Ensure @gradio/client's submit iterator releases as expected #8715

Merged
merged 2 commits into from
Jul 11, 2024

Conversation

pngwn
Copy link
Member

@pngwn pngwn commented Jul 8, 2024

Description

We weren't existing the iterator when the prediction completed.

Build the client and put the following file in client/js and run it with node test.js:

import { Client } from "./dist/index.js";

async function run() {
	const client = await Client.connect(
		"gradio/test_chatinterface_streaming_echo_main",
		{
			events: ["data", "status"]
		}
	);
	const result = client.submit("/chat", {
		message: "Hello!!"
	});

	for await (const msg of result) {
		console.log(msg);
	}

	console.log("ALL DONE");
}

run();

Closes #8502.

🎯 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

@pngwn pngwn requested a review from hannahblair July 8, 2024 12:52
@gradio-pr-bot
Copy link
Contributor

gradio-pr-bot commented Jul 8, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website ready! Website preview
🦄 Changes detecting...

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/9217688b8745636f0954b1da707edf0fa1fb157b/gradio-4.37.2-py3-none-any.whl

Install Gradio Python Client from this PR

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

Install Gradio JS Client from this PR

npm install https://gradio-builds.s3.amazonaws.com/9217688b8745636f0954b1da707edf0fa1fb157b/gradio-client-1.2.1.tgz
@pngwn pngwn changed the title close the iterator when the prediction stream completes Jul 8, 2024
@gradio-pr-bot
Copy link
Contributor

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
@gradio/client patch
gradio patch
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Ensure @gradio/client's submit iterator releases as expected

Maintainers or the PR author can modify the PR title to modify this entry.

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.
@pngwn pngwn merged commit a6b3c6c into main Jul 11, 2024
7 checks passed
@pngwn pngwn deleted the 8502-client-iterator branch July 11, 2024 11:01
@pngwn pngwn mentioned this pull request Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants