Retrieving training list
- Print
- PDF
Retrieving training list
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Available in Classic and VPC
Retrieves a list of generated trainings.
Requests
Describes the request format. The request format is as follows:
| Method | URI |
|---|---|
| GET | /tuning/v2/tasks |
Header
The following describes the header.
| Field | Requirement status | Description |
|---|---|---|
| X-NCP-APIGW-TIMESTAMP | Y | Time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC If the time differs from that of the API Gateway server by 5 minutes or more, then the request is considered invalid x-ncp-apigw-timestamp:{Timestamp} |
| X-NCP-IAM-ACCESS-KEY | Y | Access key ID issued from NAVER Cloud Platform portal x-ncp-iam-access-key:{Main Account Access Key} |
| X-NCP-APIGW-SIGNATURE-V2 | Y | Signature encrypted with the access key ID value and secret key x-ncp-apigw-signature-v2:{API Gateway Signature} |
| X-NCP-CLOVASTUDIO-REQUEST-ID | N | Request ID for each request |
| Content-Type | Y | application/json |
Query parameters
The following describes the parameters.
| Field | Type | Requirement status | Description |
|---|---|---|---|
| size | int | N | Page size |
| page | int | N | Page size |
Syntax
The following is an example of syntax.
curl --location --request GET 'https://clovastudio.apigw.ntruss.com/tuning/v2/tasks?page=0&size=20' \
--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>'
Responses
Describes the responses format.
Header
The following describes the header.
| Header | Requirement status | Description |
|---|---|---|
| Content-Type | - | application/json |
Body
The following describes the body.
| Field | Type | Requirement status | Description |
|---|---|---|---|
| result | object | - | Response result |
| result.totalPages | int | - | Total number of pages |
| result.totalElements | int | - | Total number of data |
| result.size | int | - | Number of data per page |
| result.number | int | - | Page number |
| result.content | object | Training information | |
| result.content.id | string | - | Training ID |
| result.content.name | string | - | Training name |
| result.content.model | string | - | Tuning model name |
| result.content.method | enum | - | Tuning method |
| result.content.taksType | string | - | Training type |
| result.content.trainEpochs | interger | - | Number of epochs to train the model |
| result.content.learningRate | double | - | Training rate: the level or degree to which model parameters are re-trained when tuning |
| result.content.status | enum | - | Training progress status |
| result.content.status.statusInfo | array | - | Training progress details |
| result.content.status.statusInfo.label | array | - | User data label, if training type is classification (null, if training type is GENERATION) |
| result.content.status.statusInfo.dataRows | int | - | Number of data |
| result.content.status.statusInfo.numOfTokens | int | - | Number of data tokens |
| result.content.status.statusInfo.currStep | int | - | Current number of training steps |
| result.content.status.statusInfo.totalTrainSteps | int | - | Total number of training steps |
| result.content.status.statusInfo.currEpoch | int | - | Current epochs |
| result.content.status.statusInfo.totalTrainEpochs | int | - | Total training epochs |
| result.content.status.statusInfo.estimatedTime | int | - | Estimated duration (average 1 epoch time * total training epochs) |
| result.content.status.statusInfo.trainLoss | double | - | Amount of training loss |
| result.content.status.statusInfo.sendWeightSuccess | boolean | - | Whether to save the training results |
| result.content.status.statusInfo.endDatetime | string | - | End date of the training |
| result.content.status.statusInfo.failureReason | string | - | Reason for training failure
|
| result.content.status.createdClientType | enum | - | Client type that requested the training |
| result.content.status.createdDate | string | - | Training generation date (ISO 8601 format) |
| result.content.status.updatedDate | string | - | Training editing date (ISO 8601 format) |
Syntax
The following is an example of syntax.
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"totalPages": "7,",
"totalElements": "122,",
"size": "20,",
"number": "0,",
"content": [
{
"id": "oi55o2ej",
"name": "230709-202307",
"model": "HCX-002",
"method": "LoRA",
"taskType": "GENERATION",
"trainEpochs": 4,
"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"
},
{
"id": "oi55o2ej",
"name": "230709-202307",
"model": "HCX-002",
"method": "LoRA",
"taskType": "GENERATION",
"trainEpochs": 4,
"learningRate": 1.0E-4,
"status": "FAILED",
"statusInfo": {
22
"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-21T20:23:08+0900",
"updatedDate": "2023-08-22T10:31:40+0900"
}
]
}
}
Was this article helpful?