# TensorChord Modelz Python SDK and CLI
[modelz-py](https://github.com/tensorchord/modelz-py) with aiohttp
Basically, [aioclient.py](modelz/aioclient.py) implements the async / aiohttp versions of `Modelz*` classes,
and [client.py](modelz/client.py) wraps around them with `asyncio.run()` calls.
- [TensorChord Modelz Python SDK and CLI](#tensorchord-modelz-python-sdk-and-cli)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [CLI Usage](#cli-usage)
- [Example Usage](#example-usage)
- [CLI Inference](#cli-inference)
- [Python Interface](#python-interface)
- [Develop](#develop)
## Installation
### pipx
This is the recommended installation method if you only want to use the CLI.
```
$ pipx install aiomodelz
```
### [pip](https://pypi.org/project/aiomodelz/)
```
$ pip install aiomodelz
```
## CLI Usage
```shell
$modelz --help
usage: modelz [-h] {inference,metrics,build} ...
modelz CLI
positional arguments:
{inference,metrics,build}
options:
-h, --help show this help message and exit
```
## Example Usage
### CLI Inference
```shell
echo "cute cat" | modelz inference $PROJECT --serde msgpack --write-file cat.jpg --read-stdin
```
### Python Interface
```python
# use dotenv to load env
from dotenv import load_dotenv
load_dotenv()
# example .env:
# MODELZ_API_KEY=mzi-*****
# MODELZ_HOST=https://{}.cloud.modelz.dev/ # use this if you're using the dev modelz cluster
# MODELZ_SSL_VERIFY=0 # disable ssl verification
from modelz import AioModelzClient, ModelzClient
...
```
## Develop
```
$ git clone https://github.com/tddschn/aiomodelz.git
$ cd aiomodelz
$ pdm install
```
Raw data
{
"_id": null,
"home_page": "",
"name": "aiomodelz",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "machine learning,deep learning",
"author": "",
"author_email": "Teddy Xinyuan Chen <45612704+tddschn@users.noreply.github.com>,TensorChord <modelz-support@tensorchord.ai>",
"download_url": "https://files.pythonhosted.org/packages/86/44/b549a3cde66a34a389b572217501022e4ee5782319c9c9fd0f20895f50ac/aiomodelz-0.4.10.tar.gz",
"platform": null,
"description": "# TensorChord Modelz Python SDK and CLI\n\n[modelz-py](https://github.com/tensorchord/modelz-py) with aiohttp\n\nBasically, [aioclient.py](modelz/aioclient.py) implements the async / aiohttp versions of `Modelz*` classes, \nand [client.py](modelz/client.py) wraps around them with `asyncio.run()` calls.\n\n- [TensorChord Modelz Python SDK and CLI](#tensorchord-modelz-python-sdk-and-cli)\n - [Installation](#installation)\n - [pipx](#pipx)\n - [pip](#pip)\n - [CLI Usage](#cli-usage)\n - [Example Usage](#example-usage)\n - [CLI Inference](#cli-inference)\n - [Python Interface](#python-interface)\n - [Develop](#develop)\n\n## Installation\n\n### pipx\n\nThis is the recommended installation method if you only want to use the CLI.\n\n```\n$ pipx install aiomodelz\n```\n\n### [pip](https://pypi.org/project/aiomodelz/)\n\n```\n$ pip install aiomodelz\n```\n\n\n## CLI Usage\n\n```shell\n$modelz --help\n\nusage: modelz [-h] {inference,metrics,build} ...\n\nmodelz CLI\n\npositional arguments:\n {inference,metrics,build}\n\noptions:\n -h, --help show this help message and exit\n```\n\n## Example Usage\n### CLI Inference\n\n```shell\necho \"cute cat\" | modelz inference $PROJECT --serde msgpack --write-file cat.jpg --read-stdin\n```\n### Python Interface\n\n```python\n# use dotenv to load env\nfrom dotenv import load_dotenv\nload_dotenv()\n\n# example .env:\n# MODELZ_API_KEY=mzi-*****\n# MODELZ_HOST=https://{}.cloud.modelz.dev/ # use this if you're using the dev modelz cluster\n# MODELZ_SSL_VERIFY=0 # disable ssl verification\n\nfrom modelz import AioModelzClient, ModelzClient\n...\n\n```\n\n\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/aiomodelz.git\n$ cd aiomodelz\n$ pdm install\n```\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "machine learning models",
"version": "0.4.10",
"project_urls": null,
"split_keywords": [
"machine learning",
"deep learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e82069530f7e81548411ca2beeb2d3239a6c0ddc0d77d7364f89a5a24d609453",
"md5": "c52619586001b10da20e68ec496b7a2d",
"sha256": "e38067a4b1098f3edf4064d4a3352aa54b5f3da5627baed775680d254a8aa905"
},
"downloads": -1,
"filename": "aiomodelz-0.4.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c52619586001b10da20e68ec496b7a2d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16390,
"upload_time": "2023-05-05T07:53:05",
"upload_time_iso_8601": "2023-05-05T07:53:05.411066Z",
"url": "https://files.pythonhosted.org/packages/e8/20/69530f7e81548411ca2beeb2d3239a6c0ddc0d77d7364f89a5a24d609453/aiomodelz-0.4.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8644b549a3cde66a34a389b572217501022e4ee5782319c9c9fd0f20895f50ac",
"md5": "6161cdc0d6b6b0f3b6832e227d95059b",
"sha256": "63c41bcd5532a7f233e7e943db5a1e676de3f172d8500279aac4a75f199fe7e0"
},
"downloads": -1,
"filename": "aiomodelz-0.4.10.tar.gz",
"has_sig": false,
"md5_digest": "6161cdc0d6b6b0f3b6832e227d95059b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11882,
"upload_time": "2023-05-05T07:53:07",
"upload_time_iso_8601": "2023-05-05T07:53:07.381538Z",
"url": "https://files.pythonhosted.org/packages/86/44/b549a3cde66a34a389b572217501022e4ee5782319c9c9fd0f20895f50ac/aiomodelz-0.4.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-05 07:53:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aiomodelz"
}
JSON