This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@gradio/client@1.0.0

Highlights

Clients 1.0 Launch! (#8468 `7cc0a0c`)

We're excited to unveil the first major release of the Gradio clients. We've made it even easier to turn any Gradio application into a production endpoint thanks to the clients' ergonomic, transparent, and portable design.

Ergonomic API 💆

Stream From a Gradio app in 5 lines

Use the submit method to get a job you can iterate over:

from gradio_client import Client

client = Client("gradio/llm_stream")

for result in client.submit("What's the best UI framework in Python?"):
    print(result)

import { Client } from "@gradio/client";

const client = await Client.connect("gradio/llm_stream")
const job = client.submit("/predict", {"text": "What's the best UI framework in Python?"})

for await (const msg of job) console.log(msg.data)

Use the same keyword arguments as the app

from gradio_client import Client

client = Client("http://127.0.0.1:7860/")
result = client.predict(
        message="Hello!!",
        system_prompt="You are helpful AI.",
        tokens=10,
        api_name="/chat"
)
print(result)

import { Client } from "@gradio/client";

const client = await Client.connect("http://127.0.0.1:7860/");
const result = await client.predict("/chat", {      
        message: "Hello!!",         
        system_prompt: "Hello!!",       
        tokens: 10, 
});

console.log(result.data);

Better Error Messages

If something goes wrong in the upstream app, the client will raise the same exception as the app provided that show_error=True in the original app's launch() function, or it's a gr.Error exception.

Transparent Design 🪟

Anything you can do in the UI, you can do with the client:

🔒 Authentication
🛑 Job Cancelling
ℹ️ Access Queue Position and API
📕 View the API information

Here's an example showing how to display the queue position of a pending job:

from gradio_client import Client

client = Client("gradio/diffusion_model")

job = client.submit("A cute cat")
while not job.done():
    status = job.status()
    print(f"Current in position {status.rank} out of {status.queue_size}")

Portable Design ⛺️

The client can run from pretty much any python and javascript environment (node, deno, the browser, Service Workers).

Here's an example using the client from a Flask server using gevent:

from gevent import monkey
monkey.patch_all()

from gradio_client import Client
from flask import Flask, send_file
import time

app = Flask(__name__)

imageclient = Client("gradio/diffusion_model")

@app.route("/gen")
def gen():
      result = imageclient.predict(
                "A cute cat",
                api_name="/predict"
              )
      return send_file(result)

if __name__ == "__main__":
      app.run(host="0.0.0.0", port=5000)

1.0 Migration Guide and Breaking Changes

Python

The serialize argument of the Client class was removed. Has no effect.
The upload_files argument of the Client was removed.
All filepaths must be wrapped in the handle_file method. Example:

from gradio_client import Client, handle_file

client = Client("gradio/image_captioner")
client.predict(handle_file("cute_cat.jpg"))

The output_dir argument was removed. It is not specified in the download_files argument.

Javascript The client has been redesigned entirely. It was refactored from a function into a class. An instance can now be constructed by awaiting the connect method.

const app = await Client.connect("gradio/whisper")

The app variable has the same methods as the python class (submit, predict, view_api, duplicate).

Additional Changes

#8243 - Set orig_name in python client file uploads.
#8264 - Make exceptions in the Client more specific.
#8247 - Fix api recorder.
#8276 - Fix bug where client could not connect to apps that had self signed certificates.
#8245 - Cancel server progress from the python client.
#8200 - Support custom components in gr.load
#8182 - Convert sse calls in client from async to sync.
#7732 - Adds support for kwargs and default arguments in the python client, and improves how parameter information is displayed in the "view API" page.
#7888 - Cache view_api info in server and python client.
#7575 - Files should now be supplied as file(...) in the Client, and some fixes to gr.load() as well.
#8401 - Add CDN installation to JS docs.
#8299 - Allow JS Client to work with authenticated spaces 🍪.
#8408 - Connect heartbeat if state created in render. Also fix config cleanup bug #8407.
#8258 - Improve URL handling in JS Client.
#8322 - ensure the client correctly handles all binary data.
#8296 - always create a jwt when connecting to a space if a hf_token is present.
#8285 - use the correct query param to pass the jwt to the heartbeat event.
#8272 - ensure client works for private spaces.
#8197 - Add support for passing keyword args to data in JS client.
#8252 - Client node fix.
#8209 - Rename eventSource_Factory and fetch_implementation.
#8109 - Implement JS Client tests.
#8211 - remove redundant event source logic.
#8179 - rework upload to be a class method + pass client into each component.
#8181 - Ensure connectivity to private HF spaces with SSE protocol.
#8169 - Only connect to heartbeat if needed.
#8118 - Add eventsource polyfill for Node.js and browser environments.
#7646 - Refactor JS Client.
#7974 - Fix heartbeat in the js client to be Lite compatible.
#7926 - Fixes streaming event race condition.

Thanks @freddyaboulton!

Features

#8370 48eeea4 - Refactor Cancelling Logic To Use /cancel. Thanks @freddyaboulton!

Fixes

#8477 d5a9604 - Fix js client bundle. Thanks @pngwn!
#8451 9d2d605 - Change client submit API to be an AsyncIterable and support more platforms. Thanks @pngwn!
#8462 6447dfa - Improve file handling in JS Client. Thanks @hannahblair!
#8439 63d36fb - Handle gradio apps using state in the JS Client. Thanks @hannahblair!

gradio_client@1.0.0

Highlights

Clients 1.0 Launch! (#8468 `7cc0a0c`)

Ergonomic API 💆

Stream From a Gradio app in 5 lines

Use the submit method to get a job you can iterate over:

from gradio_client import Client

client = Client("gradio/llm_stream")

for result in client.submit("What's the best UI framework in Python?"):
    print(result)

import { Client } from "@gradio/client";

const client = await Client.connect("gradio/llm_stream")
const job = client.submit("/predict", {"text": "What's the best UI framework in Python?"})

for await (const msg of job) console.log(msg.data)

Use the same keyword arguments as the app

from gradio_client import Client

client = Client("http://127.0.0.1:7860/")
result = client.predict(
        message="Hello!!",
        system_prompt="You are helpful AI.",
        tokens=10,
        api_name="/chat"
)
print(result)

import { Client } from "@gradio/client";

const client = await Client.connect("http://127.0.0.1:7860/");
const result = await client.predict("/chat", {      
        message: "Hello!!",         
        system_prompt: "Hello!!",       
        tokens: 10, 
});

console.log(result.data);

Better Error Messages

Transparent Design 🪟

Anything you can do in the UI, you can do with the client:

🔒 Authentication
🛑 Job Cancelling
ℹ️ Access Queue Position and API
📕 View the API information

Here's an example showing how to display the queue position of a pending job:

from gradio_client import Client

client = Client("gradio/diffusion_model")

job = client.submit("A cute cat")
while not job.done():
    status = job.status()
    print(f"Current in position {status.rank} out of {status.queue_size}")

Portable Design ⛺️

The client can run from pretty much any python and javascript environment (node, deno, the browser, Service Workers).

Here's an example using the client from a Flask server using gevent:

from gevent import monkey
monkey.patch_all()

from gradio_client import Client
from flask import Flask, send_file
import time

app = Flask(__name__)

imageclient = Client("gradio/diffusion_model")

@app.route("/gen")
def gen():
      result = imageclient.predict(
                "A cute cat",
                api_name="/predict"
              )
      return send_file(result)

if __name__ == "__main__":
      app.run(host="0.0.0.0", port=5000)

1.0 Migration Guide and Breaking Changes

Python

The serialize argument of the Client class was removed. Has no effect.
The upload_files argument of the Client was removed.
All filepaths must be wrapped in the handle_file method. Example:

from gradio_client import Client, handle_file

client = Client("gradio/image_captioner")
client.predict(handle_file("cute_cat.jpg"))

The output_dir argument was removed. It is not specified in the download_files argument.

Javascript The client has been redesigned entirely. It was refactored from a function into a class. An instance can now be constructed by awaiting the connect method.

const app = await Client.connect("gradio/whisper")

The app variable has the same methods as the python class (submit, predict, view_api, duplicate).

Additional Changes

#8243 - Set orig_name in python client file uploads.
#8264 - Make exceptions in the Client more specific.
#8247 - Fix api recorder.
#8276 - Fix bug where client could not connect to apps that had self signed certificates.
#8245 - Cancel server progress from the python client.
#8200 - Support custom components in gr.load
#8182 - Convert sse calls in client from async to sync.
#7732 - Adds support for kwargs and default arguments in the python client, and improves how parameter information is displayed in the "view API" page.
#7888 - Cache view_api info in server and python client.
#7575 - Files should now be supplied as file(...) in the Client, and some fixes to gr.load() as well.
#8401 - Add CDN installation to JS docs.
#8299 - Allow JS Client to work with authenticated spaces 🍪.
#8408 - Connect heartbeat if state created in render. Also fix config cleanup bug #8407.
#8258 - Improve URL handling in JS Client.
#8322 - ensure the client correctly handles all binary data.
#8296 - always create a jwt when connecting to a space if a hf_token is present.
#8285 - use the correct query param to pass the jwt to the heartbeat event.
#8272 - ensure client works for private spaces.
#8197 - Add support for passing keyword args to data in JS client.
#8252 - Client node fix.
#8209 - Rename eventSource_Factory and fetch_implementation.
#8109 - Implement JS Client tests.
#8211 - remove redundant event source logic.
#8179 - rework upload to be a class method + pass client into each component.
#8181 - Ensure connectivity to private HF spaces with SSE protocol.
#8169 - Only connect to heartbeat if needed.
#8118 - Add eventsource polyfill for Node.js and browser environments.
#7646 - Refactor JS Client.
#7974 - Fix heartbeat in the js client to be Lite compatible.
#7926 - Fixes streaming event race condition.

Thanks @freddyaboulton!

Features

#8444 2cd02ff - Remove deprecated parameters from Python Client. Thanks @abidlabs!

gradio@4.34.0

Features

#8370 48eeea4 - Refactor Cancelling Logic To Use /cancel. Thanks @freddyaboulton!
#8460 8628899 - Support Bash in Api Recorder. Thanks @aliabd!
#8417 96d8de2 - add delete event to File component. Thanks @pngwn!
#8444 2cd02ff - Remove deprecated parameters from Python Client. Thanks @abidlabs!
#8473 8ca93d4 - Improve design of api recorder. Thanks @aliabd!
#8445 5c8915b - Add cURL to view API Page and add a dedicated Guide. Thanks @abidlabs!

Fixes

#8477 d5a9604 - Fix js client bundle. Thanks @pngwn!
#8451 9d2d605 - Change client submit API to be an AsyncIterable and support more platforms. Thanks @pngwn!
#8462 6447dfa - Improve file handling in JS Client. Thanks @hannahblair!
#8439 63d36fb - Handle gradio apps using state in the JS Client. Thanks @hannahblair!

@gradio/audio@0.11.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/button@0.2.41

@gradio/button@0.2.41

Dependency updates

@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/chatbot@0.10.9

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/audio@0.11.8
@gradio/image@0.11.8
@gradio/video@0.8.8
@gradio/markdown@0.7.6

@gradio/code@0.6.9

Dependency updates

@gradio/statustracker@0.6.0
@gradio/upload@0.11.0

@gradio/dataframe@0.8.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/button@0.2.41
@gradio/markdown@0.7.6

@gradio/dataset@0.1.41

Dependency updates

@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/downloadbutton@0.1.18

Dependency updates

@gradio/client@1.0.0
@gradio/button@0.2.41

@gradio/file@0.8.0

Features

#8417 96d8de2 - add delete event to File component. Thanks @pngwn!

Fixes

#8451 9d2d605 - Change client submit API to be an AsyncIterable and support more platforms. Thanks @pngwn!

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/gallery@0.10.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/file@0.8.0
@gradio/upload@0.11.0
@gradio/image@0.11.8

@gradio/image@0.11.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/imageeditor@0.7.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/image@0.11.8

@gradio/lite@4.34.0

Dependency updates

gradio@4.34.0

@gradio/model3d@0.10.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/multimodaltextbox@0.4.9

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/image@0.11.8

@gradio/preview@0.9.1

Fixes

#8439 63d36fb - Handle gradio apps using state in the JS Client. Thanks @hannahblair!

@gradio/simpleimage@0.5.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/tootils@0.5.0

Features

#8417 96d8de2 - add delete event to File component. Thanks @pngwn!

Dependency updates

@gradio/statustracker@0.6.0

@gradio/upload@0.11.0

Features

#8417 96d8de2 - add delete event to File component. Thanks @pngwn!

Dependency updates

@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/uploadbutton@0.6.9

Dependency updates

@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/button@0.2.41

@gradio/video@0.8.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0
@gradio/image@0.11.8

website@0.31.3

Features

#8471 a9e6595 - Tweak meta titles and descriptions for clients. Thanks @aliabd!

Dependency updates

@gradio/code@0.6.9

@gradio/annotatedimage@0.6.8

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/upload@0.11.0

@gradio/app@1.36.0

Features

#8370 48eeea4 - Refactor Cancelling Logic To Use /cancel. Thanks @freddyaboulton!
#8460 8628899 - Support Bash in Api Recorder. Thanks @aliabd!
#8444 2cd02ff - Remove deprecated parameters from Python Client. Thanks @abidlabs!
#8473 8ca93d4 - Improve design of api recorder. Thanks @aliabd!
#8445 5c8915b - Add cURL to view API Page and add a dedicated Guide. Thanks @abidlabs!

Fixes

#8451 9d2d605 - Change client submit API to be an AsyncIterable and support more platforms. Thanks @pngwn!
#8439 63d36fb - Handle gradio apps using state in the JS Client. Thanks @hannahblair!

Dependency updates

@gradio/code@0.6.9
@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/file@0.8.0
@gradio/upload@0.11.0
@gradio/annotatedimage@0.6.8
@gradio/audio@0.11.8
@gradio/button@0.2.41
@gradio/chatbot@0.10.9
@gradio/dataframe@0.8.8
@gradio/dataset@0.1.41
@gradio/downloadbutton@0.1.18
@gradio/fileexplorer@0.4.9
@gradio/gallery@0.10.8
@gradio/image@0.11.8
@gradio/imageeditor@0.7.8
@gradio/model3d@0.10.8
@gradio/multimodaltextbox@0.4.9
@gradio/simpleimage@0.5.8
@gradio/uploadbutton@0.6.9
@gradio/video@0.8.8
@gradio/accordion@0.3.16
@gradio/checkbox@0.3.6
@gradio/checkboxgroup@0.5.6
@gradio/colorpicker@0.3.6
@gradio/column@0.1.2
@gradio/dropdown@0.7.6
@gradio/fallback@0.3.6
@gradio/form@0.1.18
@gradio/group@0.1.1
@gradio/highlightedtext@0.7.0
@gradio/html@0.2.6
@gradio/json@0.2.6
@gradio/label@0.3.6
@gradio/markdown@0.7.6
@gradio/number@0.4.6
@gradio/paramviewer@0.4.15
@gradio/plot@0.4.6
@gradio/radio@0.5.6
@gradio/row@0.1.3
@gradio/simpledropdown@0.2.6
@gradio/simpletextbox@0.2.6
@gradio/slider@0.4.6
@gradio/tabitem@0.2.10
@gradio/tabs@0.2.9
@gradio/textbox@0.6.5

@gradio/fileexplorer@0.4.9

Dependency updates

@gradio/statustracker@0.6.0
@gradio/client@1.0.0
@gradio/file@0.8.0
@gradio/upload@0.11.0
@gradio/checkbox@0.3.6

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
	Storybook	building...
:unicorn:	Changes	skipped!	Workflow log

gradio-app / gradio

chore: update versions #8458

Releases

@gradio/client@1.0.0

Highlights

Clients 1.0 Launch! (#8468 7cc0a0c)

Ergonomic API 💆

Transparent Design 🪟

Portable Design ⛺️

1.0 Migration Guide and Breaking Changes

Additional Changes

Features

Fixes

gradio_client@1.0.0

Highlights

Clients 1.0 Launch! (#8468 7cc0a0c)

Ergonomic API 💆

Transparent Design 🪟

Portable Design ⛺️

1.0 Migration Guide and Breaking Changes

Additional Changes

Features

gradio@4.34.0

Features

Fixes

@gradio/audio@0.11.8

Dependency updates

@gradio/button@0.2.41

Dependency updates

@gradio/chatbot@0.10.9

Dependency updates

@gradio/code@0.6.9

Dependency updates

@gradio/dataframe@0.8.8

Dependency updates

@gradio/dataset@0.1.41

Dependency updates

@gradio/downloadbutton@0.1.18

Dependency updates

@gradio/file@0.8.0

Features

Fixes

Dependency updates

@gradio/gallery@0.10.8

Dependency updates

@gradio/image@0.11.8

Dependency updates

@gradio/imageeditor@0.7.8

Dependency updates

@gradio/lite@4.34.0

Dependency updates

@gradio/model3d@0.10.8

Dependency updates

@gradio/multimodaltextbox@0.4.9

Dependency updates

@gradio/preview@0.9.1

Fixes

@gradio/simpleimage@0.5.8

Dependency updates

@gradio/tootils@0.5.0

Features

Dependency updates

@gradio/upload@0.11.0

Features

Dependency updates

@gradio/uploadbutton@0.6.9

Dependency updates

@gradio/video@0.8.8

Dependency updates

website@0.31.3

Features

Dependency updates

@gradio/annotatedimage@0.6.8

Dependency updates

@gradio/app@1.36.0

Features

Fixes

Dependency updates

@gradio/fileexplorer@0.4.9

Dependency updates

Clients 1.0 Launch! (#8468 `7cc0a0c`)

Clients 1.0 Launch! (#8468 `7cc0a0c`)