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

Update README.md with 5.0 info and GIFs #9564

Merged
merged 7 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![gradio-ui](https://github.com/gradio-app/gradio/actions/workflows/tests-js.yml/badge.svg)](https://github.com/gradio-app/gradio/actions/workflows/tests-js.yml)
[![PyPI](https://img.shields.io/pypi/v/gradio)](https://pypi.org/project/gradio/)
[![PyPI downloads](https://img.shields.io/pypi/dm/gradio)](https://pypi.org/project/gradio/)
![Python version](https://img.shields.io/badge/python-3.8+-important)
![Python version](https://img.shields.io/badge/python-3.10+-important)
[![Twitter follow](https://img.shields.io/twitter/follow/gradio?style=social&label=follow)](https://twitter.com/gradio)

[Website](https://gradio.app)
Expand All @@ -26,19 +26,19 @@

Gradio is an open-source Python package that allows you to quickly **build** a demo or web application for your machine learning model, API, or any arbitrary Python function. You can then **share** a link to your demo or web application in just a few seconds using Gradio's built-in sharing features. *No JavaScript, CSS, or web hosting experience needed!*

<img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/gradio-guides/lcm-screenshot-3.gif" style="padding-bottom: 10px">
<img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/gradio-guides/gif-version.gif" style="padding-bottom: 10px">
Copy link
Collaborator

Choose a reason for hiding this comment

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

dang nice gif


It just takes a few lines of Python to create a beautiful demo like the one above, so let's get started 💫
It just takes a few lines of Python to create your own demo, so let's get started 💫

### Installation

**Prerequisite**: Gradio requires [Python 3.8 or higher](https://www.python.org/downloads/)
**Prerequisite**: Gradio 5 requires [Python 3.10 or higher](https://www.python.org/downloads/)


We recommend installing Gradio using `pip`, which is included by default in Python. Run this in your terminal or command prompt:

```
pip install gradio
pip install --upgrade gradio
```


Expand Down
2 changes: 1 addition & 1 deletion client/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The Gradio client works with any Gradio Space, whether it be an image generator,

If you already have a recent version of `gradio`, then the `gradio_client` is included as a dependency.

Otherwise, the lightweight `gradio_client` package can be installed from pip (or pip3) and works with Python versions 3.8 or higher:
Otherwise, the lightweight `gradio_client` package can be installed from pip (or pip3) and works with Python versions 3.10 or higher:

```bash
$ pip install gradio_client
Expand Down
Binary file modified demo/hello_world_4/screenshot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion guides/01_getting-started/01_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It just takes a few lines of Python to create a demo like the one above, so let'

## Installation

**Prerequisite**: Gradio requires [Python 3.8 or higher](https://www.python.org/downloads/).
**Prerequisite**: Gradio requires [Python 3.10 or higher](https://www.python.org/downloads/).


We recommend installing Gradio using `pip`, which is included by default in Python. Run this in your terminal or command prompt:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Custom Components in 5 minutes

Gradio 4.0 introduces Custom Components -- the ability for developers to create their own custom components and use them in Gradio apps.
You can publish your components as Python packages so that other users can use them as well.
Users will be able to use all of Gradio's existing functions, such as `gr.Blocks`, `gr.Interface`, API usage, themes, etc. with Custom Components.
This guide will cover how to get started making custom components.
Gradio includes the ability for developers to create their own custom components and use them in Gradio apps.You can publish your components as Python packages so that other users can use them as well.

Users will be able to use all of Gradio's existing functions, such as `gr.Blocks`, `gr.Interface`, API usage, themes, etc. with Custom Components. This guide will cover how to get started making custom components.

## Installation

Expand All @@ -13,7 +12,7 @@ You will need to have:
* pip 21.3+ (`python -m pip install --upgrade pip`)
* Node.js v16.14+ (<a href="https://nodejs.dev/en/download/package-manager/" target="_blank">install here</a>)
* npm 9+ (<a href="https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/" target="_blank">install here</a>)
* Gradio 4.0+ (`pip install --upgrade gradio`)
* Gradio 5+ (`pip install --upgrade gradio`)

## The Workflow

Expand Down
3 changes: 2 additions & 1 deletion guides/08_custom-components/06_frequently-asked-questions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Frequently Asked Questions

## What do I need to install before using Custom Components?
Before using Custom Components, make sure you have Python 3.10+, Node.js v18+, npm 9+, and Gradio 4.0+ installed.

Before using Custom Components, make sure you have Python 3.10+, Node.js v18+, npm 9+, and Gradio 4.0+ (preferably Gradio 5.0+) installed.

## Are custom components compatible between Gradio 4.0 and 5.0?

Expand Down
2 changes: 1 addition & 1 deletion guides/08_custom-components/07_pdf-component-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is a sneak preview of what our finished component will look like:
![demo](https://gradio-builds.s3.amazonaws.com/assets/PDFDisplay.png)

## Step 0: Prerequisites
Make sure you have gradio 4.0 installed as well as node 18+.
Make sure you have gradio 4.0 or higher installed as well as node 18+.
As of the time of publication, the latest release is 4.1.1.
Also, please read the [Five Minute Tour](./custom-components-in-five-minutes) of custom components and the [Key Concepts](./key-component-concepts) guide before starting.

Expand Down
4 changes: 2 additions & 2 deletions guides/10_other-tutorials/deploying-gradio-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This app creates a simple interface that greets the user by name.
Next, we'll create a Dockerfile to specify how our app should be built and run in a Docker container. Create a file named `Dockerfile` in the same directory as your app with the following content:

```dockerfile
FROM python:3.8-slim
FROM python:3.10-slim

WORKDIR /usr/src/app
COPY . .
Expand All @@ -47,7 +47,7 @@ CMD ["python", "app.py"]
```

This Dockerfile performs the following steps:
- Starts from a Python 3.8 slim image.
- Starts from a Python 3.10 slim image.
- Sets the working directory and copies the app into the container.
- Installs Gradio (you should install all other requirements as well).
- Exposes port 7860 (Gradio's default port).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Using virtual environments ensures that you can work on multiple Python projects

To install Gradio on a Windows system in a virtual environment, follow these steps:

1. **Install Python**: Ensure you have Python 3.8 or higher installed. You can download it from [python.org](https://www.python.org/). You can verify the installation by running `python --version` or `python3 --version` in Command Prompt.
1. **Install Python**: Ensure you have Python 3.10 or higher installed. You can download it from [python.org](https://www.python.org/). You can verify the installation by running `python --version` or `python3 --version` in Command Prompt.


2. **Create a Virtual Environment**:
Expand Down Expand Up @@ -62,7 +62,7 @@ The installation steps on MacOS and Linux are similar to Windows but with some d
1. **Install Python**:
Python usually comes pre-installed on MacOS and most Linux distributions. You can verify the installation by running `python --version` in the terminal (note that depending on how Python is installed, you might have to use `python3` instead of `python` throughout these steps).

Ensure you have Python 3.8 or higher installed. If you do not have it installed, you can download it from [python.org](https://www.python.org/).
Ensure you have Python 3.10 or higher installed. If you do not have it installed, you can download it from [python.org](https://www.python.org/).

2. **Create a Virtual Environment**:
Open Terminal and navigate to your project directory. Then create a virtual environment using:
Expand Down
2 changes: 1 addition & 1 deletion guides/cn/01_getting-started/01_quickstart.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 快速开始

**先决条件**:Gradio 需要 Python 3.8 或更高版本,就是这样!
**先决条件**:Gradio 需要 Python 3.10 或更高版本,就是这样!

## Gradio 是做什么的?

Expand Down
2 changes: 1 addition & 1 deletion readme_files/zh-cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![gradio-js](https://github.com/gradio-app/gradio/actions/workflows/ui.yml/badge.svg)](https://github.com/gradio-app/gradio/actions/workflows/ui.yml)
[![PyPI](https://img.shields.io/pypi/v/gradio)](https://pypi.org/project/gradio/)
[![PyPI downloads](https://img.shields.io/pypi/dm/gradio)](https://pypi.org/project/gradio/)
![Python version](https://img.shields.io/badge/python-3.8+-important)
![Python version](https://img.shields.io/badge/python-3.10+-important)
[![Twitter follow](https://img.shields.io/twitter/follow/gradio?style=social&label=follow)](https://twitter.com/gradio)

[官网](https://gradio.app)
Expand Down
2 changes: 1 addition & 1 deletion readme_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![gradio-ui](https://github.com/gradio-app/gradio/actions/workflows/ui.yml/badge.svg)](https://github.com/gradio-app/gradio/actions/workflows/ui.yml)
[![PyPI](https://img.shields.io/pypi/v/gradio)](https://pypi.org/project/gradio/)
[![PyPI downloads](https://img.shields.io/pypi/dm/gradio)](https://pypi.org/project/gradio/)
![Python version](https://img.shields.io/badge/python-3.8+-important)
![Python version](https://img.shields.io/badge/python-3.10+-important)
[![Twitter follow](https://img.shields.io/twitter/follow/gradio?style=social&label=follow)](https://twitter.com/gradio)

[Website](https://gradio.app)
Expand Down
2 changes: 1 addition & 1 deletion testing-guidelines/quality-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ All unspecified version segments (`x`) refer to latest.

| Software | Version(s) | Operating System(s) |
| -------- | --------------------- | --------------------------------- |
| Python | `3.8.x` | `ubuntu-latest`, `windows-latest` |
| Python | `3.10.x` | `ubuntu-latest`, `windows-latest` |
| Node | `18.x.x` | `ubuntu-latest` |
| Browser | `playwright-chrome-x` | `ubuntu-latest` |

Expand Down
Loading