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

Fix API docs for multimodal_textbox.py #10131

Merged
merged 6 commits into from
Dec 5, 2024
Merged

Fix API docs for multimodal_textbox.py #10131

merged 6 commits into from
Dec 5, 2024

Conversation

abidlabs
Copy link
Member

@abidlabs abidlabs commented Dec 5, 2024

API Snippet shows up fine now:

image

with

import gradio as gr

def fn(x, y):
    print(message)

with gr.Blocks() as demo:
    t = gr.File()
    text = gr.MultimodalTextbox()
    text.submit(fn=fn, inputs=[t, text])
demo.launch()

Closes: #10104

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Dec 5, 2024

🪼 branch checks and previews

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

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/f3d4dbfc7b0ba956c0d6bfd73a0ff4cff1d93f70/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@f3d4dbfc7b0ba956c0d6bfd73a0ff4cff1d93f70#subdirectory=client/python"

Install Gradio JS Client from this PR

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

Use Lite from this PR

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

@gradio-pr-bot
Copy link
Collaborator

gradio-pr-bot commented Dec 5, 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.

Fix API docs for multimodal_textbox.py

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.

"""
Parameters:
value: Expects a {dict} with "text" and "files", both optional. The files array is a list of file paths or URLs.
Returns:
The value to display in the multimodal textbox. Files information as a list of FileData objects.
"""
if value is None:
return MultimodalData(text="", files=[])
return None
Copy link
Member Author

Choose a reason for hiding this comment

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

This is fine since we coerce in the frontend anyways:

$: if (value === null) value = { text: "", files: [] };

@abidlabs abidlabs marked this pull request as ready for review December 5, 2024 16:13
@abidlabs
Copy link
Member Author

abidlabs commented Dec 5, 2024

Thanks folks!

@abidlabs abidlabs merged commit 4984e84 into main Dec 5, 2024
22 checks passed
@abidlabs abidlabs deleted the multimodal-api branch December 5, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve API docs for gr.MultimodalTextbox
4 participants