Merge pull request #848 from awslabs/doc

feat: improved infer process docs
pull/852/head
Elon N 2024-07-15 17:10:24 +08:00 committed by GitHub
commit 9b4f8db06a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 29 additions and 5 deletions

View File

@ -1,4 +1,4 @@
## How-to inference through API
## How-to inference on Stable Diffusion through API
- Create Endpoint through `CreateEndpoint`
- Upload model file through `CreateCheckpoint`, Please refer to: `API Upload Checkpoint Process`
@ -8,9 +8,16 @@
- Create an inference job through `CreateInferenceJob`
- Based on the presigned address `api_params_s3_upload_url` returned by `CreatInferenceJob` Upload inference parameters
- Start an inference job through `StartInferenceJob`
- Obtain an inference job through `GetInferenceJob`, check the status, and stop the request if successful
- Get an inference job through `GetInferenceJob`, check the status, and stop the request if successful
### Real-time inference
- Create an inference job through `CreateInferenceJob`
- Based on the pre signed address `api_params_s3_upload_url` returned by `CreatInferenceJob` Upload inference parameters
- Starting the inference job through `StartInferenceJob`, the real-time inference job will obtain the inference result in this interface
- Starting the inference job through `StartInferenceJob`, the real-time inference job will get the inference result in this interface
## How-to inference on ComfyUI through API
### Async inference
- Create Endpoint through `CreateEndpoint`
- Create an inference job through `CreateExecute`
- Get an inference job through `GetExcute`, check the status, and stop the request if successful

View File

@ -1,4 +1,4 @@
## API を通してのインファレンス方法
## Stable Diffusion の API を通してのインファレンス方法
- `CreateEndpoint`を使ってエンドポイントを作成する
- `CreateCheckpoint`を使ってモデルファイルをアップロードする。`API Upload Checkpoint Process`を参照してください。
@ -14,3 +14,11 @@
- `CreateInferenceJob`を使ってインファレンスジョブを作成する
- `CreatInferenceJob`で返された事前署名アドレス`api_params_s3_upload_url`に基づいてインファレンスパラメータをアップロードする
- `StartInferenceJob`を使ってインファレンスジョブを開始する。リアルタイムインファレンスジョブはこのインターフェイスでインファレンス結果を取得する
## ComfyUI の推論を実行する方法
### 非同期推論
- `CreateEndpoint` による推理端点の作成
- `CreateExecute` による推理タスクの作成
- `GetExcute` による推理タスクの作成

View File

@ -1,4 +1,4 @@
## 如何完成一个推理?
## 如何完成一个 Stable Diffusion 推理?
- 通过 `CreateEndpoint` 创建推理端点
- 通过 `CreateCheckpoint` 上传模型文件,请参考 `API 上传模型文件流程`
@ -14,3 +14,12 @@
- 通过 `CreateInferenceJob` 创建推理作业
- 根据 `CreateInferenceJob` 返回的预签名地址 `api_params_s3_upload_url` 上传推理参数
- 通过 `StartInferenceJob` 开始推理作业,实时推理作业会在本接口获得推理结果
## 如何完成一个 ComfyUI 推理?
### 异步推理
- 通过 `CreateEndpoint` 创建推理端点
- 通过 `CreateExecute` 创建推理任务
- 通过 `GetExcute` 创建推理任务