Upload 18 files

gradio-bbox/CITATION.cff

@@ -0,0 +1,45 @@
+cff-version: 1.2.0
+message: Please cite this project using these metadata.
+title: "Gradio: Hassle-free sharing and testing of ML models in the wild"
+abstract: >-
+  Accessibility is a major challenge of machine learning (ML).
+  Typical ML models are built by specialists and require
+  specialized hardware/software as well as ML experience to
+  validate. This makes it challenging for non-technical
+  collaborators and endpoint users (e.g. physicians) to easily
+  provide feedback on model development and to gain trust in
+  ML. The accessibility challenge also makes collaboration
+  more difficult and limits the ML researcher's exposure to
+  realistic data and scenarios that occur in the wild. To
+  improve accessibility and facilitate collaboration, we
+  developed an open-source Python package, Gradio, which
+  allows researchers to rapidly generate a visual interface
+  for their ML models. Gradio makes accessing any ML model as
+  easy as sharing a URL. Our development of Gradio is informed
+  by interviews with a number of machine learning researchers
+  who participate in interdisciplinary collaborations. Their
+  feedback identified that Gradio should support a variety of
+  interfaces and frameworks, allow for easy sharing of the
+  interface, allow for input manipulation and interactive
+  inference by the domain expert, as well as allow embedding
+  the interface in iPython notebooks. We developed these
+  features and carried out a case study to understand Gradio's
+  usefulness and usability in the setting of a machine
+  learning collaboration between a researcher and a
+  cardiologist.
+authors:
+  - family-names: Abid
+    given-names: Abubakar
+  - family-names: Abdalla
+    given-names: Ali
+  - family-names: Abid
+    given-names: Ali
+  - family-names: Khan
+    given-names: Dawood
+  - family-names: Alfozan
+    given-names: Abdulrahman
+  - family-names: Zou
+    given-names: James
+doi: 10.48550/arXiv.1906.02569
+date-released: 2019-06-06
+url: https://arxiv.org/abs/1906.02569

gradio-bbox/CONTRIBUTING.md

@@ -0,0 +1,138 @@
+# Contributing to Gradio
+
+Prerequisites:
+
+- [Python 3.8+](https://www.python.org/downloads/)
+- [Node.js v16.14+](https://nodejs.dev/en/download/package-manager/) (only needed if you are making changes to the frontend)
+- [pnpm 8.1+](https://pnpm.io/8.x/installation) (only needed if you are making changes to the frontend)
+
+More than 80 awesome developers have contributed to the `gradio` library, and we'd be thrilled if you would like be the next `gradio` contributor! Start by cloning this repo and installing Gradio locally:
+
+### Install Gradio locally from the `main` branch
+
+- Clone this repo
+- Navigate to the repo folder and run
+
+```bash
+bash scripts/install_gradio.sh
+```
+
+- Build the front end
+
+```
+bash scripts/build_frontend.sh
+```
+
+### Install development requirements
+
+In order to be able to run the Python linter, formatter, and unit tests, do the following:
+
+- Navigate to the repo folder and install test requirements (note that it is highly recommended to use a virtual environment running **Python 3.9** since the versions are pinned)
+
+```
+bash scripts/install_test_requirements.sh
+```
+
+- If you have a different Python version and conflicting packages during the installation, please first run:
+
+```
+bash scripts/create_test_requirements.sh
+```
+
+### Using dev containers
+
+Instead of the above steps, you can alternatively use dev containers. This is supported on all platforms (macOS/Windows/Linux).
+
+Prerequisites:
+
+- An editor which supports dev containers, like VS Code
+- Docker support on the host computer:
+  - macOS: [Docker Desktop 2.0+](https://www.docker.com/products/docker-desktop/)
+  - Windows: [Docker Desktop 2.0+](https://www.docker.com/products/docker-desktop/)
+  - Linux: [Docker CE/EE 18.06+](https://docs.docker.com/get-docker/) and [Docker Compose 1.21+](https://docs.docker.com/compose/install/)
+- If using VS Code, the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
+
+Steps:
+
+- Clone repository
+- Open it in editor
+- For VS Code, execute `Dev Containers: Reopen in container` command
+
+For detailed instructions, please see the [Dev Containers tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial).
+
+### Extra tidbits
+
+- You can run gradio scripts in reload mode which will watch for changes in the `gradio` folder and reload the app if changes are made.
+
+```
+gradio app.py
+```
+
+- To develop the frontend app, you should also follow [js/README.md](js/README.md).
+
+- To run all of the tests, do:
+
+```
+bash scripts/run_all_tests.sh
+```
+
+### Structure of the Repository
+
+It's helpful to know the overall structure of the repository so that you can focus on the part of the source code you'd like to contribute to
+
+- `/gradio`: contains the Python source code for the library
+  - `/gradio/interface.py`: contains the Python source code for the core `Interface` class
+  - `/gradio/blocks.py`: contains the Python source code for the core `Blocks` class
+  - `/gradio/components.py`: contains the Python source code for the `components`, you can add your custom components here.
+- `/js`: contains the HTML/JS/CSS source code for the library ([start here for frontend changes](/js/README.md))
+- `/test`: contains Python unit tests for the library
+- `/demo`: contains demos that are used in the documentation, you can find `Gradio` examples over here.
+- `/website`: contains the code for the Gradio website (www.gradio.app). See the README in the `/website` folder for more details
+
+### Continuous Integration and Testing
+
+All PRs must pass the continuous integration tests before merging. To test locally, you can run `python -m unittest` from the repo directory.
+
+## Submitting PRs
+
+All PRs should be against `main`. Direct commits to main are blocked, and PRs require an approving review to merge into main. By convention, the Gradio maintainers will review PRs when:
+
+- An initial review has been requested, and
+- A description of the change (with a link to the GitHub PR) has been added to CHANGELOG.md, and
+- A maintainer (@abidlabs, @aliabid94, @aliabd, @AK391, @dawoodkhan82, @pngwn, @freddyaboulton) is tagged in the PR comments and asked to complete a review
+
+We ask that you make sure initial CI checks are passing before requesting a review. One of the Gradio maintainers will merge the PR when all the checks are passing.
+
+Do not forget the format the backend before pushing.
+
+```
+bash scripts/format_backend.sh
+```
+
+```
+bash scripts/format_frontend.sh
+```
+
+## CI checks
+
+Currently the following checks are run in CI:
+
+### Gradio library (`gradio` package)
+
+```
+bash scripts/lint_backend.sh
+bash scripts/type_check_backend.sh
+python -m pytest -m "not flaky" --ignore=client
+python -m pytest -m "flaky" --ignore=client
+```
+
+### Gradio client (`gradio_client` package)
+
+```
+cd client/python
+bash scripts/lint.sh
+python -m pytest -m "not flaky"
+python -m pytest -m "flaky"
+```
+
+_Could these guidelines be clearer? Feel free to open a PR to help us faciltiate open-source contributions!_

gradio-bbox/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gradio-bbox/README.md

@@ -0,0 +1,46 @@
+# Gradio-BBox
+
+<img src="https://github.com/chencn2020/SEAGULL/raw/main/imgs/Logo/logo.png" alt="SEAGULL" style="height: auto; width: 100%; margin-bottom: 3%;">
+
+It is an extension to official [gradio-3.36.1](https://github.com/gradio-app/gradio), which supports **drawing boxes** on top of an image. 
+
+This repository is forked from [Gradio-Osprey-Demo](https://github.com/LiWentomng/gradio-osprey-demo).
+
+Thanks for their great contribution.
+
+## Install
+
+### 1. Install Node.js
+
+We install it on Ubuntu with:
+
+```
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+
+source ~/.bashrc # or ~/.zshrc based on which one you use
+
+nvm install v18.16.0
+```
+
+
+### 2. Install ppnm
+
+```
+curl -fsSL https://get.pnpm.io/install.sh | sh -
+
+source ~/.bashrc # or ~/.zshrc based on which one you use
+
+pnpm --version  # check if success
+```
+
+### 3. Install gradio
+
+```
+git clone https://github.com/chencn2020/gradio-bbox.git
+
+cd gradio-bbox
+
+bash scripts/build_frontend.sh
+
+pip install -e .
+```

gradio-bbox/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, we would be very grateful if you could email us at [email protected]. This is the preferred approach instead of opening a public issue. We take all vulnerability reports seriously, and will work to patch the vulnerability immediately. Whenever possible, we will credit the person or people who report the security vulnerabilities after it has been patched.

gradio-bbox/globals.d.ts

@@ -0,0 +1,34 @@
+declare global {
+	interface Window {
+		__gradio_mode__: "app" | "website";
+		launchGradio: Function;
+		launchGradioFromSpaces: Function;
+		gradio_config: Config;
+		scoped_css_attach: (link: HTMLLinkElement) => void;
+		__is_colab__: boolean;
+		parentIFrame?: {
+			scrollTo: (x: number, y: number) => void;
+		};
+	}
+}
+
+export interface Config {
+	auth_required: boolean | undefined;
+	auth_message: string;
+	components: any[];
+	css: string | null;
+	dependencies: any[];
+	dev_mode: boolean;
+	enable_queue: boolean;
+	layout: any;
+	mode: "blocks" | "interface";
+	root: string;
+	theme: string;
+	title: string;
+	version: string;
+	space_id: string | null;
+	is_colab: boolean;
+	show_api: boolean;
+	stylesheets: string[];
+	path: string;
+}

gradio-bbox/package.json

@@ -0,0 +1,106 @@
+{
+	"name": "gradio-ui",
+	"version": "0.0.1",
+	"description": "Gradio UI packages",
+	"scripts": {
+		"dev": "pnpm css && pnpm --filter @gradio/client build && pnpm --filter @gradio/app dev",
+		"css": "pnpm --filter @gradio/theme generate",
+		"build": "pnpm css && pnpm --filter @gradio/client build && pnpm --filter @gradio/app build:local --emptyOutDir",
+		"build:cdn": "pnpm --filter @gradio/client build && pnpm --filter @gradio/app build:cdn --emptyOutDir",
+		"build:website": "pnpm --filter @gradio/app build:website --emptyOutDir",
+		"build:cdn-local": "TEST_CDN=TRUE pnpm build:cdn",
+		"preview:cdn-server": "sirv ./gradio/templates/cdn --single --port=4321 --cors",
+		"preview:cdn-app": "pnpm --filter @gradio/cdn-test dev",
+		"preview:cdn-local": "run-p preview:cdn-server preview:cdn-app",
+		"format:check": "prettier --ignore-path .config/.prettierignore --check --config .config/.prettierrc.json .",
+		"format:write": "prettier --ignore-path .config/.prettierignore --write --config .config/.prettierrc.json .",
+		"lint": "ESLINT_USE_FLAT_CONFIG=true eslint -c .config/eslint.config.js js client/js",
+		"ts:check": "svelte-check --tsconfig tsconfig.json",
+		"test": "pnpm --filter @gradio/client build && vitest dev --config .config/vitest.config.ts",
+		"test:run": "pnpm --filter @gradio/client build && vitest run --config .config/vitest.config.ts --reporter=verbose",
+		"test:node": "TEST_MODE=node pnpm  vitest run --config .config/vitest.config.ts",
+		"test:browser": "pnpm --filter @gradio/app test:browser",
+		"test:browser:full": "run-s build test:browser",
+		"test:browser:verbose": "GRADIO_TEST_VERBOSE=true pnpm test:browser",
+		"test:browser:dev": "pnpm --filter @gradio/app test:browser:dev",
+		"ci:publish": "pnpm publish --no-git-checks --access public -r",
+		"ci:version": "changeset version && pnpm i --lockfile-only",
+		"storybook": "storybook dev -p 6006 --config-dir js/storybook",
+		"build-storybook": "storybook build --config-dir js/storybook",
+		"chromatic": "chromatic --exit-zero-on-changes",
+		"test:ct": "playwright test -c ./.config/playwright-ct.config.ts"
+	},
+	"type": "module",
+	"author": "",
+	"license": "ISC",
+	"private": true,
+	"dependencies": {
+		"@changesets/changelog-github": "^0.4.8",
+		"@changesets/cli": "^2.26.1",
+		"@csstools/postcss-global-data": "^2.0.0",
+		"@gradio/tootils": "workspace:^0.0.1",
+		"@playwright/experimental-ct-svelte": "^1.35.1",
+		"@playwright/test": "^1.35.1",
+		"@sveltejs/vite-plugin-svelte": "^2.4.2",
+		"@tailwindcss/forms": "^0.5.0",
+		"@testing-library/dom": "^9.0.0",
+		"@testing-library/jest-dom": "^5.16.5",
+		"@testing-library/user-event": "^14.0.0",
+		"@types/node": "^20.3.1",
+		"@types/testing-library__jest-dom": "^5.14.6",
+		"@typescript-eslint/eslint-plugin": "^5.60.0",
+		"@typescript-eslint/parser": "^5.60.0",
+		"autoprefixer": "^10.4.4",
+		"babylonjs": "^5.17.1",
+		"babylonjs-loaders": "^5.17.1",
+		"eslint": "^8.43.0",
+		"eslint-plugin-svelte": "^2.31.0",
+		"globals": "^13.20.0",
+		"jsdom": "^22.1.0",
+		"kleur": "^4.1.5",
+		"msw": "^1.2.2",
+		"node-html-parser": "^6.0.0",
+		"npm-run-all": "^4.1.5",
+		"plotly.js-dist-min": "^2.10.1",
+		"polka": "^1.0.0-next.22",
+		"pollen-css": "^4.6.1",
+		"postcss": "^8.4.6",
+		"postcss-custom-media": "10",
+		"postcss-nested": "^5.0.6",
+		"postcss-prefix-selector": "^1.16.0",
+		"prettier": "^3.0.0",
+		"prettier-plugin-css-order": "^1.3.1",
+		"prettier-plugin-svelte": "^2.10.1",
+		"sirv": "^2.0.2",
+		"sirv-cli": "^2.0.2",
+		"svelte": "^4.0.0",
+		"svelte-check": "^3.4.4",
+		"svelte-i18n": "^3.6.0",
+		"svelte-preprocess": "^5.0.4",
+		"tailwindcss": "^3.1.6",
+		"tinyspy": "^2.0.0",
+		"typescript": "^5.0.0",
+		"vite": "^4.3.9",
+		"vitest": "^0.33.0"
+	},
+	"devDependencies": {
+		"@playwright/test": "^1.35.1",
+		"@storybook/addon-a11y": "^7.0.24",
+		"@storybook/addon-essentials": "^7.0.23",
+		"@storybook/addon-interactions": "^7.0.23",
+		"@storybook/addon-links": "^7.0.23",
+		"@storybook/addon-styling": "^1.3.1",
+		"@storybook/addon-svelte-csf": "^3.0.3",
+		"@storybook/blocks": "^7.0.23",
+		"@storybook/manager-api": "^7.0.23",
+		"@storybook/svelte": "^7.0.23",
+		"@storybook/svelte-vite": "^7.0.23",
+		"@storybook/testing-library": "^0.2.0",
+		"@storybook/theming": "^7.0.23",
+		"@types/three": "^0.153.0",
+		"chromatic": "^6.19.9",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0",
+		"storybook": "^7.0.23"
+	}
+}

gradio-bbox/pnpm-workspace.yaml

@@ -0,0 +1,3 @@
+packages:
+  - 'js/*'
+  - 'client/js'

gradio-bbox/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+requires = ["hatchling", "hatch-requirements-txt", "hatch-fancy-pypi-readme>=22.5.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "gradio"
+dynamic = ["version", "dependencies", "readme"]
+description = "Python library for easily interacting with trained machine learning models"
+license = "Apache-2.0"
+requires-python = ">=3.8"
+authors = [
+  { name = "Abubakar Abid", email = "[email protected]" },
+  { name = "Ali Abid", email = "[email protected]" },
+  { name = "Ali Abdalla", email = "[email protected]" },
+  { name = "Dawood Khan", email = "[email protected]" },
+  { name = "Ahsen Khaliq", email = "[email protected]" },
+  { name = "Pete Allen", email = "[email protected]" },
+  { name = "Ömer Faruk Özdemir", email = "[email protected]" },
+]
+keywords = ["machine learning", "reproducibility", "visualization"]
+
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'License :: OSI Approved :: Apache Software License',
+  'Operating System :: OS Independent',
+  'Programming Language :: Python :: 3',
+  'Programming Language :: Python :: 3 :: Only',
+  'Programming Language :: Python :: 3.8',
+  'Programming Language :: Python :: 3.9',
+  'Programming Language :: Python :: 3.10',
+  'Programming Language :: Python :: 3.11',
+  'Topic :: Scientific/Engineering',
+  'Topic :: Scientific/Engineering :: Artificial Intelligence',
+  'Topic :: Scientific/Engineering :: Visualization',
+]
+
+[project.scripts]
+gradio = "gradio.cli:cli"
+upload_theme = "gradio.themes.upload_theme:main"
+
+[project.urls]
+Homepage = "https://github.com/gradio-app/gradio"
+
+[tool.hatch.version]
+path = "gradio/version.txt"
+pattern = "(?P<version>.+)"
+
+[tool.hatch.metadata.hooks.requirements_txt]
+filename = "requirements.txt"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+fragments = [
+  { path = "README.md" },
+]
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = "(website/homepage|readme_files)/"
+replacement = 'https://raw.githubusercontent.com/gradio-app/gradio/main/\g<1>/'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = 'demo/([\S]*.gif)'
+replacement = 'https://raw.githubusercontent.com/gradio-app/gradio/main/demo/\g<1>'
+
+[tool.hatch.build]
+artifacts = [
+  "/gradio/templates",
+]
+
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/gradio",
+  "/test",
+  "/README.md",
+  "/requirements.txt",
+]
+
+[tool.ruff]
+target-version = "py37"
+extend-select = [
+  "B",
+  "C",
+  "I",
+  "N",
+  "SIM",
+  "UP",
+]
+ignore = [
+  "C901", # function is too complex (TODO: un-ignore this)
+  "B023", # function definition in loop (TODO: un-ignore this)
+  "B008", # function call in argument defaults
+  "B017", # pytest.raises considered evil
+  "B028", # explicit stacklevel for warnings
+  "E501", # from scripts/lint_backend.sh
+  "SIM105", # contextlib.suppress (has a performance cost)
+  "SIM117", # multiple nested with blocks (doesn't look good with gr.Row etc)
+  "UP007", # use X | Y for type annotations (TODO: can be enabled once Pydantic plays nice with them)
+]
+
+[tool.ruff.per-file-ignores]
+"demo/*" = [
+  "E402", # Demos may have imports not at the top
+  "E741", # Demos may have ambiguous variable names
+  "F405", # Demos may use star imports
+  "I", # Don't care about import order
+]
+"gradio/__init__.py" = [
+  "F401", # "Imported but unused" (TODO: it would be better to be explicit and use __all__)
+]
+"gradio/routes.py" = [
+  "UP006", # Pydantic on Python 3.7 requires old-style type annotations (TODO: drop when Python 3.7 is dropped)
+]

gradio-bbox/readme_template.md

@@ -0,0 +1,68 @@
+<div align="center">
+
+  [<img src="readme_files/gradio.svg" alt="gradio" width=300>](https://gradio.app)<br>
+  <em>Build & share delightful machine learning apps easily</em>
+
+  [![gradio-backend](https://github.com/gradio-app/gradio/actions/workflows/backend.yml/badge.svg)](https://github.com/gradio-app/gradio/actions/workflows/backend.yml)
+  [![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)
+  [![Twitter follow](https://img.shields.io/twitter/follow/gradio?style=social&label=follow)](https://twitter.com/gradio)
+
+  [Website](https://gradio.app)
+  | [Documentation](https://gradio.app/docs/)
+  | [Guides](https://gradio.app/guides/)
+  | [Getting Started](https://gradio.app/getting_started/)
+  | [Examples](demo/)
+  | [中文](readme_files/zh-cn#readme)
+</div>
+
+# Gradio: Build Machine Learning Web Apps — in Python
+
+Gradio is an open-source Python library that is used to build machine learning and data science demos and web applications.
+
+With Gradio, you can quickly create a beautiful user interface around your machine learning models or data science workflow and let people "try it out" by dragging-and-dropping in their own images,
+pasting text, recording their own voice, and interacting with your demo, all through the browser.
+
+![Interface montage](readme_files/header-image.jpg)
+
+Gradio is useful for:
+
+- **Demoing** your machine learning models for clients/collaborators/users/students.
+
+- **Deploying** your models quickly with automatic shareable links and getting feedback on model performance.
+
+- **Debugging** your model interactively during development using built-in manipulation and interpretation tools.
+
+$getting_started
+
+## Open Source Stack
+
+Gradio is built with many wonderful open-source libraries, please support them as well!
+
+[<img src="readme_files/huggingface_mini.svg" alt="huggingface" height=40>](https://huggingface.co)
+[<img src="readme_files/python.svg" alt="python" height=40>](https://www.python.org)
+[<img src="readme_files/fastapi.svg" alt="fastapi" height=40>](https://fastapi.tiangolo.com)
+[<img src="readme_files/encode.svg" alt="encode" height=40>](https://www.encode.io)
+[<img src="readme_files/svelte.svg" alt="svelte" height=40>](https://svelte.dev)
+[<img src="readme_files/vite.svg" alt="vite" height=40>](https://vitejs.dev)
+[<img src="readme_files/pnpm.svg" alt="pnpm" height=40>](https://pnpm.io)
+[<img src="readme_files/tailwind.svg" alt="tailwind" height=40>](https://tailwindcss.com)
+
+## License
+
+Gradio is licensed under the Apache License 2.0 found in the [LICENSE](LICENSE) file in the root directory of this repository.
+
+## Citation
+
+Also check out the paper *[Gradio: Hassle-Free Sharing and Testing of ML Models in the Wild](https://arxiv.org/abs/1906.02569), ICML HILL 2019*, and please cite it if you use Gradio in your work.
+
+```
+@article{abid2019gradio,
+  title = {Gradio: Hassle-Free Sharing and Testing of ML Models in the Wild},
+  author = {Abid, Abubakar and Abdalla, Ali and Abid, Ali and Khan, Dawood and Alfozan, Abdulrahman and Zou, James},
+  journal = {arXiv preprint arXiv:1906.02569},
+  year = {2019},
+}
+```

gradio-bbox/render_readme.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+import re
+from pathlib import Path
+
+README_TEMPLATE_FILEPATH = "readme_template.md"
+GETTING_STARTED_TEMPLATE_FILEPATH = "guides/01_getting-started/01_quickstart.md"
+
+readme_template = Path(README_TEMPLATE_FILEPATH).read_text()
+getting_started_template = Path(GETTING_STARTED_TEMPLATE_FILEPATH).read_text()
+
+# Extract all the code and demo tags from the getting started template
+code_tags = re.findall(r"\$code_([^\s]+)", getting_started_template)
+demo_tags = re.findall(r"\$demo_([^\s]+)", getting_started_template)
+codes = {}
+demos = {}
+
+for src in code_tags:
+    context = Path(f"demo/{src}/run.py").read_text()
+    # Replace the condition to run the demo directly with actual launch code
+    context = re.sub(r"if __name__(.*[\n$]*)*", "demo.launch()", context)
+    codes[src] = f"```python\n{context}\n```\n"  # Convert to Markdown code block
+
+for src in demo_tags:
+    demos[src] = f"![`{src}` demo](demo/{src}/screenshot.gif)"
+
+# Replace the headers in the getting started template with a smaller header (e.g. H3 instead of H2) to
+# make the README more readable and less cluttered.
+getting_started_template = re.sub(r"^(#+)", r"#\1", getting_started_template, flags=re.MULTILINE)
+readme_template = readme_template.replace("$getting_started", getting_started_template)
+
+# Now put the codes and the screenshots in the README template
+readme_template = re.sub(r"\$code_([^\s]+)", lambda x: codes[x.group(1)], readme_template)
+readme_template = re.sub(r"\$demo_([^\s]+)", lambda x: demos[x.group(1)], readme_template)
+
+# Save the README template to the actual README.md file (with a note about the editing)
+EDITING_NOTE = ("<!-- DO NOT EDIT THIS FILE DIRECTLY. INSTEAD EDIT THE `readme_template.md` OR "
+                "`guides/1)getting_started/1)quickstart.md` TEMPLATES AND THEN RUN `render_readme.py` SCRIPT. -->")
+Path("README.md").write_text(f"{EDITING_NOTE}\n\n{readme_template}")

gradio-bbox/renovate.json

@@ -0,0 +1,24 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"extends": [
+		"github>whitesource/merge-confidence:beta",
+		"config:base",
+		":preserveSemverRanges",
+		"group:allNonMajor",
+		":semanticCommitTypeAll(chore)"
+	],
+	"ignorePaths": [
+		"**/demo/**",
+		"**/requirements.txt",
+		"**/Dockerfile",
+		"**/website/**"
+	],
+	"ignoreDeps": [
+		"lazy-brush",
+		"babylonjs",
+		"babylonjs-loaders",
+		"postcss-load-config",
+		"postcss-nested",
+		"svelte"
+	]
+}

gradio-bbox/requirements.txt

@@ -0,0 +1,26 @@
+aiofiles
+aiohttp
+altair>=4.2.0
+fastapi
+ffmpy
+gradio_client>=0.2.7
+httpx
+huggingface_hub>=0.14.0
+Jinja2
+markdown-it-py[linkify]>=2.0.0
+pygments>=2.12.0
+mdit-py-plugins<=0.3.3
+markupsafe
+matplotlib
+numpy
+orjson
+pandas
+pillow
+pydantic
+python-multipart
+pydub
+pyyaml
+requests
+semantic_version
+uvicorn>=0.14.0
+websockets>=10.0

gradio-bbox/style.md

@@ -0,0 +1,160 @@
+# component-styles
+
+## Textbox
+
+| name        | type                                 | description                    |
+| ----------- | ------------------------------------ | ------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of text input          |
+| `border`    | `bool` or `(bool, bool, bool, bool)` | borders of text input          |
+| `container` | `bool`                               | show or hide the container box |
+
+## Number
+
+| name        | type                                 | description                    |
+| ----------- | ------------------------------------ | ------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of text input          |
+| `border`    | `bool` or `(bool, bool, bool, bool)` | borders of text input          |
+| `container` | `bool`                               | show or hide the container box |
+
+## Slider
+
+| name        | type   | description                    |
+| ----------- | ------ | ------------------------------ |
+| `container` | `bool` | show or hide the container box |
+
+## Checkbox
+
+| name        | type                                 | description                    |
+| ----------- | ------------------------------------ | ------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of checkbox            |
+| `border`    | `bool` or `(bool, bool, bool, bool)` | borders of checkbox            |
+| `container` | `bool`                               | show or hide the container box |
+
+## Checkbox Group
+
+| name             | type                                 | description                               |
+| ---------------- | ------------------------------------ | ----------------------------------------- |
+| `rounded`        | `bool` or `(bool, bool, bool, bool)` | corners of checkboxes                     |
+| `container`      | `bool`                               | show or hide the container box            |
+| `item_container` | `bool`                               | show or hide the checkbox container boxes |
+
+## Radio
+
+| name             | type   | description                            |
+| ---------------- | ------ | -------------------------------------- |
+| `container`      | `bool` | show or hide the container box         |
+| `item_container` | `bool` | show or hide the radio container boxes |
+
+## Dropdown
+
+| name        | type                                 | description                    |
+| ----------- | ------------------------------------ | ------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of input               |
+| `border`    | `bool` or `(bool, bool, bool, bool)` | borders of input               |
+| `container` | `bool`                               | show or hide the container box |
+
+## Image
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Video
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Audio
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## File
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Dataframe
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Timeseries
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Label
+
+| name        | type   | description                    |
+| ----------- | ------ | ------------------------------ |
+| `container` | `bool` | show or hide the container box |
+
+## HighlightedText
+
+| name        | type                                 | description                    |
+| ----------- | ------------------------------------ | ------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of labels              |
+| `color_map` | `Dict[str, str]`                     | color map of labels and colors |
+| `container` | `bool`                               | show or hide the container box |
+
+## JSON
+
+| name        | type   | description                    |
+| ----------- | ------ | ------------------------------ |
+| `container` | `bool` | show or hide the container box |
+
+## HTML
+
+Nothing
+
+## Gallery
+
+| name        | type                                      | description                         |
+| ----------- | ----------------------------------------- | ----------------------------------- |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)`      | corners of images                   |
+| `grid`      | `int` or `(int, int, int, int, int, int)` | grid for images                     |
+| `height`    | `"auto"`                                  | height of gallery (auto or default) |
+| `container` | `bool`                                    | show or hide the container box      |
+
+## Chatbot
+
+| name        | type                                 | description                                      |
+| ----------- | ------------------------------------ | ------------------------------------------------ |
+| `rounded`   | `bool` or `(bool, bool, bool, bool)` | corners of chat bubbles                          |
+| `color_map` | `Dict[str, str]`                     | color map of user and bot color for chat bubbles |
+
+## Model3D
+
+| name      | type                                 | description         |
+| --------- | ------------------------------------ | ------------------- |
+| `rounded` | `bool` or `(bool, bool, bool, bool)` | corners of main box |
+
+## Plot
+
+Nothing (yet)
+
+## Markdown
+
+Nothing
+
+## Button
+
+| name         | type                                 | description                             |
+| ------------ | ------------------------------------ | --------------------------------------- |
+| `rounded`    | `bool` or `(bool, bool, bool, bool)` | corners of button                       |
+| `border`     | `bool` or `(bool, bool, bool, bool)` | borders of button                       |
+| `full_width` | `bool`                               | whether button expand to fill container |
+
+## Dataset
+
+Nothing
+
+## Variable
+
+Nothing

gradio-bbox/test-strategy.md

@@ -0,0 +1,110 @@
+# Test Strategy
+
+Very brief, mildly aspirational test strategy document. This isn't where we are but it is where we want to get to.
+
+This document does not detail how to setup an environment or how to run the tests locally nor does it contain any best practices that we try to follow when writing tests, that information exists in the [contributing guide](https://github.com/gradio-app/gradio/blob/main/CONTRIBUTING.md).
+
+## Objectives
+
+The purposes of all testing activities on Gradio fit one of the following objectives:
+
+1. Ensure that the Gradio library functions as we expect it to.
+2. Enable the maintenance team to quickly identify both the presence and source of defects.
+3. Prevent regressions, i.e. if we fix something it should stay fixed.
+4. Improve the quality of the codebase in order to ease maintenance efforts.
+5. Reduce the amount of manual testing required.
+
+## Scope
+
+Testing is always a tradeoff. We can't cover everything unless we want to spend all of our time writing and running tests. We should focus on a few keys areas.
+
+We should not focus on code coverage but on test coverage following the below criteria:
+
+- The documented Gradio API (that's the bit that users interact with via python) should be tested thoroughly. (1)
+- Additional gradio elements that are both publicly available and used internally (such as the Python and JS client libraries) should be tested thoroughly. (1)
+- Additional gradio elements that are publicly available should be tested as throughly as is reasonable (this could be things like demos/the gradio CLI/ other tooling). The importance of each individual component. and the appropriate investment of effort, needs to assessed on a case-by-case basis. (1)
+- Element boundaries should be tested where there is reasonable cause to do so (e.g. config generation) (1)
+- Implementation details should only be tested where there is sufficient complexity to warrant it. (1)
+- Bug fixes should be accompanied by tests wherever is reasonably possible. (3)
+
+## Types of testing
+
+Our tests will broadly fall into one of three categories:
+
+- Static Quality checks
+- Dynamic 'Code' tests
+- Dynamic Functional tests
+
+### Static Quality checks
+
+Static quality check are generally very fast to run and do not require building the code base. They also provide the least value. These tests would be things like linting, typechecking, and formatting.
+
+While they offer little in terms of testing functionality they align very closely with objective (4, 5) as they generally help to keep the codebase in good shape and offer very fast feedback. Such check are almost free from an authoring point of view as fixes can be mostly automated (either via scripts or editor integrations).
+
+### Dynamic code tests
+
+These tests generally test either isolated pieces of code or test the relationship between parts of the code base. They sometimes test functionality or give indications of working functionality but never offer enough confidence to rely on them solely.
+
+These test are usually either unit or integration tests. They are generally pretty quick to write (especially unit tests) and run and offer a moderate amount of confidence. They align closely with Objectives 2 and 3 and a little bit of 1.
+
+This kind of tests should probably make up the bulk of our handwritten tests.
+
+### Dynamic functional tests
+
+These tests give by far the most confidence as they are testing only the functionality of the software and do so by running the entire software itself, exactly as a user would.
+
+This aligns very closely with objective 1 but significantly impacts objective 5, as these tests are costly to both write and run. Despite the value, due to the downside we should try to get as much out of other tests types as we can, reserving functional testing for complex use cases and end-to-end journey.
+
+Tests in this category could be browser-based end-to-end tests, accessibility tests, or performance tests. They are sometimes called acceptance tests.
+
+## Testing tools
+
+We currently use the following tools:
+
+### Static quality checks
+
+- Python type-checking (python)
+- Black linting (python)
+- ruff formatting (python)
+- prettier formatting (javascript/svelte)
+- TypeScript type-checking (javascript/svelte)
+- eslint linting (javascript/svelte) [in progress]
+
+### Dynamic code tests
+
+- pytest (python unit and integration tests)
+- vitest (node-based unit and integration tests)
+- playwright (browser-based unit and integration tests)
+
+### Functional/acceptance tests
+
+- playwright (full end to end testing)
+- chromatic (visual testing) [in progress]
+- Accessibility testing [to do]
+
+## Supported environments and versions
+
+All operating systems refer to the current runner variants supported by GitHub actions.
+
+All unspecified version segments (`x`) refer to latest.
+
+| Software | Version(s)            | Operating System(s)               |
+| -------- | --------------------- | --------------------------------- |
+| Python   | `3.8.x`               | `ubuntu-latest`, `windows-latest` |
+| Node     | `18.x.x`              | `ubuntu-latest`                   |
+| Browser  | `playwright-chrome-x` | `ubuntu-latest`                   |
+
+## Test execution
+
+Tests need to be executed in a number of environments and at different stages on the development cycle in orsder to be useful. The requirements for tests are as follows:
+
+- **Locally**: it is important that developers can easily run most tests locally to ensure a passing suite before making a PR. There are some exceptions to this, certain tests may require access to secret values which we cannot make available to all possible contributors for practical security reasons. It is reasonable that it isn't possible to run these tests but they should be disabled by default when running locally.
+- **CI** - It is _critical_ that all tests run successfully in CI with no exceptions. Not every tests is required to pass to satisfy CI checks for practical reasons but it is required that all tests should run in CI and notify us if something unexpected happens in order for the development team to take appropriate action.
+
+For instructions on how to write and run tests see the [contributing guide](https://github.com/gradio-app/gradio/blob/main/CONTRIBUTING.md).
+
+## Managing defects
+
+As we formalise our testing strategy and bring / keep our test up to standard, it is important that we have some principles on managing defects as they ocurr/ are reported. For now we can have one very simple rule:
+
+- Every bug fix should be accompanied by a test that failed before the fix and passes afterwards. This test should _typically_ be a dynamic code test but it could be a linting rule or new type if that is appropriate. There are always exceptions but we should think very carefully before ignoring this rule.

gradio-bbox/tsconfig.json

@@ -0,0 +1,52 @@
+{
+	"compilerOptions": {
+		"moduleResolution": "node",
+		"module": "es2020",
+		"lib": ["es2020", "DOM"],
+		"target": "es2020",
+		/**
+			svelte-preprocess cannot figure out whether you have a value or a type, so tell TypeScript
+			to enforce using \`import type\` instead of \`import\` for Types.
+			*/
+		"verbatimModuleSyntax": true,
+		"resolveJsonModule": true,
+		"strict": true,
+		"sourceMap": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"allowJs": true,
+		"checkJs": true,
+		"outDir": "dist",
+		"baseUrl": ".",
+		"paths": {
+			"./pure": ["./pure.js"]
+		}
+	},
+	"exclude": [
+		"**/dist/**/*",
+		"**/public/**/*",
+		"**/.config/**/*",
+		"**/*.test.ts",
+		"**/dist",
+		".github/**/*",
+		"**/demo/**/*",
+		"**/gradio/**/*",
+		"**/guides/**/*",
+		"**/readme_files/**/*",
+		"**/scripts/**/*",
+		"**/test/**/*",
+		"**/website/**/*",
+		"**/node_modules/**/*",
+		"**/venv/**/*",
+		"client/js/**",
+		"**/vite.config*"
+	],
+	"include": [
+		"**/*.d.ts",
+		"**/*.js",
+		"**/*.ts",
+		"**/*.svelte",
+		"client/js/**/*"
+	]
+}