학습 조회
- 인쇄
- PDF
학습 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
학습 현황을 조회하는 API입니다. 학습 진행 상태, 현재 스텝 수 등을 확인할 수 있습니다. API 호출 시 필요한 학습 아이디는 학습 생성 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-APIGW-SIGNATURE-V2 | Y | Access Key ID 값과 Secret Key로 암호화한 서명 x-ncp-apigw-signature-v2:{API Gateway Signature} |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | 각 요청에 대한 요청 아이디 |
| Content-Type | Y | application/json |
경로 변수
경로 변수에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| taskId | string | Y | 학습 아이디 |
요청 구문
구문 예시는 다음과 같습니다.
curl --location --request GET 'clovastudio.stream.gov-ntruss.com/tuning/v1/tasks/{taskId}' \
--header 'Content-Type: application/json' \
--header 'X-NCP-APIGW-TIMESTAMP: <api_gw_time>' \
--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 | - | 학습 아이디 |
| result.name | string | - | 학습 이름 |
| result.model | string | - | 튜닝 모델 이름 |
| result.method | string | - | 튜닝 기법 |
| result.taskType | string | - | 학습 유형 |
| result.trainEpochs | integer | - | 모델을 학습한 에폭 수 |
| result.learningRate | double | - | 학습률: 튜닝 시 모델 파라미터를 재학습하는 수준이나 정도 |
| result.status | string | - | 학습 진행 상태 |
| result.statusInfo | array | - | 학습 진행 상태 상세 정보 |
| result.statusInfo.label | array | - | 학습 유형이 classification인 경우, 사용자 데이터 라벨 (학습 유형이 GENERATION인 경우, null) |
| result.statusInfo.dataRows | int | - | 데이터 수 |
| result.statusInfo.numOfTokens | int | - | 데이터 토큰 수 |
| result.statusInfo.currStep | int | - | 학습 현재 스텝 수 |
| result.statusInfo.totalTrainSteps | int | - | 학습 총 스텝 수 |
| result.statusInfo.currEpoch | int | - | 현재 에폭 |
| result.statusInfo.totalTrainEpochs | int | - | 전체 학습 에폭 |
| result.statusInfo.estimatedTime | int | - | 예상 소요 시간 (평균 1 에폭 시간 * 전체 학습 에폭) |
| result.statusInfo.trainLoss | double | - | 학습 손실 양 |
| result.statusInfo.sendWeightSuccess | boolean | - | 학습 결과물 저장 여부 |
| result.statusInfo.endDatetime | string | - | 학습 종료 날짜 |
| result.statusInfo.failureReason | string | - | 학습 진행 상태가 FAILED인 이유 |
| result.statusInfo.message | string | - | failureReason 상세 메시지 |
| result.createdClientType | string | - | 학습을 요청한 클라이언트 유형 |
| result.createdDate | string | - | 학습 생성 날짜 (ISO 8601 형식) |
| result.updatedDate | string | - | 학습 수정 날짜 (ISO 8601 형식) |
failureReason 상세 메시지
학습 실패 이유(failureReason)와 학습 실패 이유별 상세 메시지(message)에 대한 설명은 다음과 같습니다.
| 학습 실패 이유 | 상세 메시지 | 설명 |
|---|---|---|
| file.extension | Unavailable file extension. Please check the file extension again. | 요청한 tuningType에 부합하는 데이터 파일 확장자가 아닌 경우 |
| file.size | Exceeded the disk usage limit. Please check if the file size is {limit} or less. | 학습 요청에서 기대하는 파일 크기를 초과한 경우 |
| file.encoding | Unsupported charset | UTF8-sig 인코딩이 아닌 경우 |
| file.format | Invalid json format. {reason} | 데이터셋 파일(.json/.jsonl)의 디코딩이 불가능한 경우 |
| file.format | Invalid dataset: required field empty. {column} | 데이터셋 파일에 필수 column이 없는 경우 |
| file.format | Invalid dataset: unexpected column. {column} | 데이터셋 파일에 예상 밖의 column이 있는 경우 |
| file.format | Invalid dataset: duplicate columns. {column} | 데이터셋 파일에 대소문자 구별이 되지 않아 중복 column이 있는 경우 |
| file.format | Invalid dataset: column order | 데이터셋 파일의 column 순서가 system_prompt, c_id, t_id, text, completion 에서 벗어난 경우 |
| file.format | Invalid dataset: {column} | 데이터셋 파일의 c_id (or t_id)가 0부터 시작해서 1씩 늘어나는 패턴을 만족하지 않거나 값이 비어 있는 경우 |
| file.error | - | 파일 읽기 오류 |
| resource.timeout | - | GPU 확보 실패로 응답 시간 초과. 다시 시도 필요 |
| clops.error | - | 학습 중 CLOps 오류 |
| train.unknown | - | 학습 중 파일 관련 외 오류 |
응답 구문
구문 예시는 다음과 같습니다.
성공
호출이 성공한 경우의 구문 예시는 다음과 같습니다.
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"id": "czf9fbky",
"name": "230821-130704",
"model": "HCX-003",
"method": "LoRA",
"taskType": "GENERATION",
"trainEpochs": 8,
"learningRate": 1.0E-4,
"status": "WAIT",
"statusInfo": {
"label": null,
"dataRows": null,
"numOfTokens": null,
"currStep": null,
"totalTrainSteps": null,
"currEpoch": null,
"totalTrainEpochs": null,
"estimatedTime": null,
"trainLoss": null,
"sendWeightSuccess": null,
"failureReason": null,
"message": null,
"endDatetime": null
},
"createdClientType": "API",
"createdDate": "2023-08-21T13:07:06+0900",
"updatedDate": "2023-08-21T13:07:06+0900"
}
}
실패
호출이 실패한 경우의 구문 예시는 다음과 같습니다.
이 문서가 도움이 되었습니까?