| Name | gradio-doctestcode JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | |
| Summary | Python library for easily interacting with trained machine learning models |
| upload_time | 2024-01-18 19:24:02 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
gradio-custom-component
gradio-template-code
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `gradio_doctestcode`
<a href="https://pypi.org/project/gradio_doctestcode/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/gradio_doctestcode"></a>
Python library for easily interacting with trained machine learning models
## Installation
```bash
pip install gradio_doctestcode
```
## Usage
```python
import gradio as gr
from gradio_doctestcode import DocTestCode
example = DocTestCode().example_inputs()
demo = gr.Interface(
lambda x:x,
DocTestCode(), # interactive version of your component
DocTestCode(), # static version of your component
# examples=[[example]], # uncomment this line to view the "example version" of your component
)
if __name__ == "__main__":
demo.launch()
```
## `DocTestCode`
### Initialization
<table>
<thead>
<tr>
<th align="left">name</th>
<th align="left" style="width: 25%;">type</th>
<th align="left">default</th>
<th align="left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>value</code></td>
<td align="left" style="width: 25%;">
```python
str | tuple[str] | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Default value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>
</tr>
<tr>
<td align="left"><code>language</code></td>
<td align="left" style="width: 25%;">
```python
"python"
| "markdown"
| "json"
| "html"
| "css"
| "javascript"
| "typescript"
| "yaml"
| "dockerfile"
| "shell"
| "r"
| None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">The language to display the code as. Supported languages listed in `gr.Code.languages`.</td>
</tr>
<tr>
<td align="left"><code>every</code></td>
<td align="left" style="width: 25%;">
```python
float | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.</td>
</tr>
<tr>
<td align="left"><code>lines</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>5</code></td>
<td align="left">None</td>
</tr>
<tr>
<td align="left"><code>label</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.</td>
</tr>
<tr>
<td align="left"><code>interactive</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">Whether user should be able to enter code or only view it.</td>
</tr>
<tr>
<td align="left"><code>show_label</code></td>
<td align="left" style="width: 25%;">
```python
bool | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">if True, will display label.</td>
</tr>
<tr>
<td align="left"><code>container</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If True, will place the component in a container - providing some extra padding around the border.</td>
</tr>
<tr>
<td align="left"><code>scale</code></td>
<td align="left" style="width: 25%;">
```python
int | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.</td>
</tr>
<tr>
<td align="left"><code>min_width</code></td>
<td align="left" style="width: 25%;">
```python
int
```
</td>
<td align="left"><code>160</code></td>
<td align="left">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>
</tr>
<tr>
<td align="left"><code>visible</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will be hidden.</td>
</tr>
<tr>
<td align="left"><code>elem_id</code></td>
<td align="left" style="width: 25%;">
```python
str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>elem_classes</code></td>
<td align="left" style="width: 25%;">
```python
list[str] | str | None
```
</td>
<td align="left"><code>None</code></td>
<td align="left">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
</tr>
<tr>
<td align="left"><code>render</code></td>
<td align="left" style="width: 25%;">
```python
bool
```
</td>
<td align="left"><code>True</code></td>
<td align="left">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
</tr>
</tbody></table>
### Events
| name | description |
|:-----|:------------|
| `change` | Triggered when the value of the DocTestCode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input. |
| `input` | This listener is triggered when the user changes the value of the DocTestCode. |
| `focus` | This listener is triggered when the DocTestCode is focused. |
| `blur` | This listener is triggered when the DocTestCode is unfocused/blurred. |
### User function
```python
def predict(
value: Any
) -> tuple | str | None:
return value
```
Raw data
{
"_id": null,
"home_page": "",
"name": "gradio-doctestcode",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "gradio-custom-component,gradio-template-Code",
"author": "",
"author_email": "YOUR NAME <YOUREMAIL@domain.com>",
"download_url": "https://files.pythonhosted.org/packages/31/3a/0c2991675f62ba8ef5d028459361c9100a1339c6fb0ed2a55f395c2c98dd/gradio_doctestcode-0.0.3.tar.gz",
"platform": null,
"description": "\n# `gradio_doctestcode`\n<a href=\"https://pypi.org/project/gradio_doctestcode/\" target=\"_blank\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/gradio_doctestcode\"></a> \n\nPython library for easily interacting with trained machine learning models\n\n## Installation\n \n```bash \npip install gradio_doctestcode\n```\n\n## Usage\n\n```python\n\nimport gradio as gr\nfrom gradio_doctestcode import DocTestCode\n\n\nexample = DocTestCode().example_inputs()\n\ndemo = gr.Interface(\n lambda x:x,\n DocTestCode(), # interactive version of your component\n DocTestCode(), # static version of your component\n # examples=[[example]], # uncomment this line to view the \"example version\" of your component\n)\n\n\nif __name__ == \"__main__\":\n demo.launch()\n\n```\n\n## `DocTestCode`\n\n### Initialization\n\n<table>\n<thead>\n<tr>\n<th align=\"left\">name</th>\n<th align=\"left\" style=\"width: 25%;\">type</th>\n<th align=\"left\">default</th>\n<th align=\"left\">description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"left\"><code>value</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | tuple[str] | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Default value to show in the code editor. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>language</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\n\"python\"\n | \"markdown\"\n | \"json\"\n | \"html\"\n | \"css\"\n | \"javascript\"\n | \"typescript\"\n | \"yaml\"\n | \"dockerfile\"\n | \"shell\"\n | \"r\"\n | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">The language to display the code as. Supported languages listed in `gr.Code.languages`.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>every</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nfloat | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>lines</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>5</code></td>\n<td align=\"left\">None</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>interactive</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">Whether user should be able to enter code or only view it.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>show_label</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">if True, will display label.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>container</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If True, will place the component in a container - providing some extra padding around the border.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>scale</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>min_width</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nint\n```\n\n</td>\n<td align=\"left\"><code>160</code></td>\n<td align=\"left\">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>visible</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will be hidden.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_id</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nstr | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>elem_classes</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nlist[str] | str | None\n```\n\n</td>\n<td align=\"left\"><code>None</code></td>\n<td align=\"left\">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>\n</tr>\n\n<tr>\n<td align=\"left\"><code>render</code></td>\n<td align=\"left\" style=\"width: 25%;\">\n\n```python\nbool\n```\n\n</td>\n<td align=\"left\"><code>True</code></td>\n<td align=\"left\">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>\n</tr>\n</tbody></table>\n\n\n### Events\n\n| name | description |\n|:-----|:------------|\n| `change` | Triggered when the value of the DocTestCode changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input. |\n| `input` | This listener is triggered when the user changes the value of the DocTestCode. |\n| `focus` | This listener is triggered when the DocTestCode is focused. |\n| `blur` | This listener is triggered when the DocTestCode is unfocused/blurred. |\n\n\n\n### User function\n\n\n\n ```python\n def predict(\n value: Any\n ) -> tuple | str | None:\n return value\n ```\n \n",
"bugtrack_url": null,
"license": "",
"summary": "Python library for easily interacting with trained machine learning models",
"version": "0.0.3",
"project_urls": null,
"split_keywords": [
"gradio-custom-component",
"gradio-template-code"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be7edcc534f015196a271a982b9e01a72cc35a70ede4960f252724d499b73482",
"md5": "c7ff98cef56ca9c7170b4d78a76d4bee",
"sha256": "6ac83e0e6484b97c8748a8818e7a1ec6ff9cb2a853afc949ce26eff0b87ded19"
},
"downloads": -1,
"filename": "gradio_doctestcode-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7ff98cef56ca9c7170b4d78a76d4bee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 308251,
"upload_time": "2024-01-18T19:24:00",
"upload_time_iso_8601": "2024-01-18T19:24:00.751728Z",
"url": "https://files.pythonhosted.org/packages/be/7e/dcc534f015196a271a982b9e01a72cc35a70ede4960f252724d499b73482/gradio_doctestcode-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "313a0c2991675f62ba8ef5d028459361c9100a1339c6fb0ed2a55f395c2c98dd",
"md5": "d00d40ca93c381d481827bb7cfe704ce",
"sha256": "3f81e8d0bc07e8da6ebe6e151d8435f5e7efeb4adae789bbb99bd804b0ea67a9"
},
"downloads": -1,
"filename": "gradio_doctestcode-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d00d40ca93c381d481827bb7cfe704ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 322101,
"upload_time": "2024-01-18T19:24:02",
"upload_time_iso_8601": "2024-01-18T19:24:02.955636Z",
"url": "https://files.pythonhosted.org/packages/31/3a/0c2991675f62ba8ef5d028459361c9100a1339c6fb0ed2a55f395c2c98dd/gradio_doctestcode-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 19:24:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gradio-doctestcode"
}
