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

Clean up gr.ChatInterface and fix API type discrepancy #10185

Merged
merged 40 commits into from
Dec 12, 2024

Conversation

abidlabs
Copy link
Member

@abidlabs abidlabs commented Dec 11, 2024

Fixes: #9375 and shaves off about 80 loc from gr.ChatInterface as well.

@abidlabs abidlabs marked this pull request as draft December 11, 2024 20:44
@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Dec 11, 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-pypi-previews.s3.amazonaws.com/d328042f58283ea25208392e96ad8728bb78adab/gradio-5.8.0-py3-none-any.whl

Install Gradio Python Client from this PR

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

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/d328042f58283ea25208392e96ad8728bb78adab/gradio-client-1.8.0.tgz

Use Lite from this PR

<script type="module" src="https://gradio-lite-previews.s3.amazonaws.com/d328042f58283ea25208392e96ad8728bb78adab/dist/lite.js""></script>

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Dec 11, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

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

With the following changelog entry.

Clean up gr.ChatInterface and fix API type discrepancy

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.

@abidlabs abidlabs added the v: patch A change that requires a patch release label Dec 11, 2024
)

@staticmethod
Copy link
Member Author

Choose a reason for hiding this comment

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

Added these two helper methods (which arguably could live in gr.Chatbot but that can be part of a separate refactoring of gr.Chatbot)

if self.is_generator:

@functools.wraps(self.fn)
async def api_fn(message, history, *args, **kwargs): # type: ignore
Copy link
Member Author

Choose a reason for hiding this comment

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

The key change (which fixes the bug) is to eliminate the separate api_fn and instead use the same submit_fn that is used in the UI for API calls.

@@ -824,7 +824,7 @@ def identity(x, y, request: gr.Request):
response = client.post(f"{API_PREFIX}/api/chat/", json={"data": ["test", None]})
assert response.status_code == 200
output = dict(response.json())
assert output["data"] == ["test", None]
assert output["data"] == [None, "test"]
Copy link
Member Author

Choose a reason for hiding this comment

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

Now the state variable is first so the None appears first, but this should not have any impact since the Client filters state variables out anyways.

@abidlabs
Copy link
Member Author

Remind me never to take on a refactoring task unless absolutely necessary.

@abidlabs abidlabs marked this pull request as ready for review December 12, 2024 00:38
Copy link
Collaborator

@dawoodkhan82 dawoodkhan82 left a comment

Choose a reason for hiding this comment

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

Tested and works great. Thanks for refactoring @abidlabs!

@abidlabs
Copy link
Member Author

Thanks @dawoodkhan82!!

@abidlabs abidlabs merged commit e525680 into main Dec 12, 2024
23 checks passed
@abidlabs abidlabs deleted the chat-interface-cleanup branch December 12, 2024 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v: patch A change that requires a patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ChatInterface type='messages', API still uses tuples format
3 participants