学習照会
- 印刷する
- PDF
学習照会
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Classic/VPC環境で利用できます。
作成した学習リストのうち、希望する学習情報を照会します。学習照会 APIの呼び出しに必要な学習 IDは、学習作成 APIのレスポンスボディで確認できます。
リクエスト
リクエスト形式について説明します。リクエスト形式は、次の通りです。
| メソッド | URI |
|---|---|
| GET | /tuning/v2/tasks/{taskId} |
ヘッダ
ヘッダの説明は次の通りです。
| フィールド | 要否 | 説明 |
|---|---|---|
| X-NCP-APIGW-TIMESTAMP | Y | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす x-ncp-apigw-timestamp:{Timestamp} |
| X-NCP-IAM-ACCESS-KEY | Y | NAVERクラウドプラットフォームポータルから発行された Access Key ID x-ncp-iam-access-key:{Main Account Access Key} |
| X-NCP-APIGW-SIGNATURE-V2 | Y | Access Key ID値と Secret Keyで暗号化した署名 x-ncp-apigw-signature-v2:{API Gateway Signature} |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | 各リクエストに対するリクエスト ID |
| Content-Type | Y | multipart/form-data |
パスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 要否 | 説明 |
|---|---|---|---|
| taskID | string | Y | 学習 ID |
構文
構文例は次の通りです。
curl --location --request GET 'https://clovastudio.apigw.ntruss.com/tuning/v2/tasks/{taskId}' \
--header 'Content-Type: application/json' \
--header 'X-NCP-APIGW-TIMESTAMP: <api_gw_time>' \
--header 'X-NCP-IAM-ACCESS-KEY: <iam_access_key>' \
--header 'X-NCP-APIGW-SIGNATURE-V2: <api_gw_sig>' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <request_id>'
レスポンス
レスポンス形式について説明します。
ヘッダ
ヘッダの説明は次の通りです。
| ヘッダ | 要否 | 説明 |
|---|---|---|
| Content-Type | - | application/json |
ボディ
ボディの説明は次の通りです。
| フィールド | タイプ | 要否 | 説明 |
|---|---|---|---|
| result | object | - | レスポンス結果 |
| result.id | string | - | 学習 ID |
| result.name | string | - | 学習名 |
| result.model | string | - | チューニングモデル名 |
| result.method | enum | - | チューニング技法 |
| result.taksType | string | - | 学習タイプ |
| result.trainEpochs | interger | - | モデルを学習したエポック数 |
| result.learningRate | double | - | 学習率: チューニング時にモデルパラメータを再学習するレベルや度合い |
| result.status | enum | - | 学主進捗状態 |
| result.status.statusInfo | array | - | 学主進捗状態の詳細情報 |
| result.status.statusInfo.label | array | - | 学習タイプが classificationの場合、ユーザーデータラベル(学習タイプが GENERATIONの場合、null) |
| result.status.statusInfo.dataRows | int | - | データ数 |
| result.status.statusInfo.numOfTokens | int | - | データトークン数 |
| result.status.statusInfo.currStep | int | - | 現在の学習ステップ数 |
| result.status.statusInfo.totalTrainSteps | int | - | 学習の総ステップ数 |
| result.status.statusInfo.currEpoch | int | - | 現在のエポック |
| result.status.statusInfo.totalTrainEpochs | int | - | 全体学習のエポック |
| result.status.statusInfo.estimatedTime | int | - | 予想所要時間(平均1エポック時間*全体学習のエポック) |
| result.status.statusInfo.trainLoss | double | - | 学習損失量 |
| result.status.statusInfo.sendWeightSuccess | boolean | - | 学習成果物の保存有無 |
| result.status.statusInfo.endDatetime | string | - | 学習終了日 |
| result.status.statusInfo.failureReason | string | - | 学習失敗理由
|
| result.status.createdClientType | enum | - | 学習をリクエストしたクライアントのタイプ |
| result.status.createdDate | string | - | 学習作成日(ISO 8601形式) |
| result.status.updatedDate | string | - | 学習修正日(ISO 8601形式) |
構文
構文例は次の通りです。
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"id": "oi55o2ej",
"name": "230709-202307",
"model": "HCX-002",
"method": "LoRA",
"taskType": "GENERATION",
"trainEpochs": 8,
"learningRate": 1.0E-4,
"status": "FAILED",
"statusInfo": {
"label": null,
"dataRows": null,
"numOfTokens": null,
"currStep": null,
"totalTrainSteps": null,
"currEpoch": null,
"totalTrainEpochs": null,
"estimatedTime": null,
"trainLoss": null,
"sendWeightSuccess": null,
"failureReason": "resource.timeout"
},
"createdClientType": "WEB",
"createdDate": "2023-08-20T20:23:08+0900",
"updatedDate": "2023-08-21T10:31:40+0900"
}
}
この記事は役に立ちましたか?