Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1c99c74

Browse files
authored
Update README.md
1 parent cc1ee6b commit 1c99c74

File tree

1 file changed

+6
-24
lines changed

1 file changed

+6
-24
lines changed

README.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
1-
# Modzy Python SDK
2-
3-
![Modzy Logo](https://www.modzy.com/wp-content/uploads/2020/06/MODZY-RGB-POS.png)
1+
![Modzy Python SDK Banner](https://github.com/modzy/sdk-python/blob/main/python-sdk-github-banner.png)
42

53
<div align="center">
64

7-
**Modzy's Python SDK queries models, submits inference jobs, and returns results directly to your editor.**
8-
9-
10-
![GitHub contributors](https://img.shields.io/github/contributors/modzy/sdk-python)
11-
![GitHub last commit](https://img.shields.io/github/last-commit/modzy/sdk-python)
12-
![GitHub Release Date](https://img.shields.io/github/issues-raw/modzy/sdk-python)
5+
![GitHub contributors](https://img.shields.io/github/contributors/modzy/sdk-python?logo=GitHub&style=flat-square)
6+
![GitHub last commit](https://img.shields.io/github/last-commit/modzy/sdk-python?logo=GitHub&style=flat-square)
7+
![GitHub issues](https://img.shields.io/github/issues-raw/modzy/sdk-python?logo=github&style=flat-square)
8+
![GitHub](https://img.shields.io/github/license/modzy/sdk-python?logo=apache&style=flat-square)
139

1410
[The job lifecycle](https://docs.modzy.com/reference/the-job-lifecycle) | [API Keys](https://docs.modzy.com/reference/api-keys-1) | [Samples](https://github.com/modzy/sdk-python/tree/main/samples) | [Documentation](https://docs.modzy.com/docs)
1511

1612
</div>
1713

1814

1915
## Installation
20-
21-
[![installation](https://github.com/modzy/sdk-python/raw/main/install.gif)](https://asciinema.org/a/0lHaPxvXTrPTp1Bb6bNea1ZCG)
22-
2316
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the SDK:
2417

2518
- `$ pip install modzy-sdk`
2619

2720
## Usage
2821

29-
3022
### Get your API key
31-
32-
33-
3423
API keys are security credentials required to perform API requests to Modzy. Our API keys are composed of an ID that is split by a dot into two parts: a public and private part.
3524

3625
The *public* part is the API keys' visible part only used to identify the key and by itself, it’s unable to perform API requests.
@@ -44,7 +33,6 @@ Find your API key in your user profile. To get your full API key click on "Get k
4433

4534

4635
### Initialize
47-
4836
Once you have a `model` and `version` identified, get authenticated with your API key.
4937

5038
```python
@@ -53,12 +41,7 @@ client = ApiClient(base_url='https://modzy.example.com/api', api_key='API Key')
5341
```
5442

5543
### Basic usage
56-
57-
The code below is applicable for `text/plain` input type.
58-
59-
![Basic Usage](https://github.com/modzy/sdk-python/raw/main/python.gif)
60-
61-
Submit a job providing the model, version, and input file:
44+
Submit an inference job to a `text/plain` model by providing the model, version, and input file:
6245

6346
```python
6447
job = client.jobs.submit_file('ed542963de', '0.0.27', {'input.txt': './some-file.txt'})
@@ -167,7 +150,6 @@ all_job_details = client.get_all_job_details()
167150

168151
Currently we support the following API routes:
169152

170-
171153
| Feature | Code |Api route
172154
| --- | --- | ---
173155
|Deploy new model|client.models.deploy()|[api/models](https://docs.modzy.com/reference/model-deployment)

0 commit comments

Comments
 (0)