Obtaining the Artifact List of a Fine-tuning Training Task_Training Job Management (New Version)_Model Training_API Reference

Function

This API is used to obtain the artifact list of a fine-tuning training task.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/training-jobs/{training_job_id}/ft-artifacts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A
training_job_id	Yes	String	Definition: Training job ID. For details, see Obtaining Training Jobs. Constraints: N/A Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
steps	No	Integer	Number of steps.
epoch	No	Integer	Number of rounds.
loss	No	Double	Loss value.
status	No	String	Status.
order_by_create_time_asc	No	Boolean	Whether to sort tasks by creation time.
limit	No	Integer	Definition: Number of returned records. Constraints: N/A Range: N/A Default Value: N/A
offset	No	Integer	Definition: Offset of data records Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Number of data records queried this time.
artifact_info	Array of ArtifactInfo objects	Artifact information.

**Table 4** ArtifactInfo
Parameter	Type	Description
artifact_type	String	Artifact type. The value can be final (final artifact) or middle (intermediate artifact).
is_best	Boolean	Whether the value is optimal.
artifact_id	String	Artifact ID. The final artifact is the model ID, and the intermediate artifact is the breakpoint ID.
continue_train_nums	Integer	Number of resumable training tasks.
asset_id	String	Asset ID after the artifact is published.
asset_name	String	Asset name after the artifact is published.
status	String	Publish status.
epoch	Integer	Number of rounds.
steps	Integer	Number of steps.
loss	Double	Loss value.
create_time	String	Creation time.
publish_error_msg	String	Error message when the artifact fails to be published.
task_infos	Array of ContinueTrainTask objects	Related task information.

**Table 5** ContinueTrainTask
Parameter	Type	Description
checkpoint_id	String	Intermediate artifact ID.
continue_task_id	String	Resumable training task ID.
continue_task_name	String	Resumable training task name.
continue_train_type	String	Resumable training task type.
skipped_steps	Integer	Number of steps to be skipped. 0 indicates that no step is skipped.
restore_training	Integer	Whether the task is a resumable training task. 0: non-resumable training, 1: resumable training
create_time	String	Creation time.
checkpoint_config	String	Intermediate artifact configuration.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error message
error_code	String	Error code
error_solution	String	Solution

Example Requests

The following shows how to query a training job whose UUID is 3faf5c03-aaa1-4cbe-879d-24b05d997347.

GET https://{endpoint}/v2/{project_id}/training-jobs/3faf5c03-aaa1-4cbe-879d-24b05d997347/ft-artifacts

Example Responses

Status code: 400

Format of the body for a common error response. The following shows the returned information when a training job with ID 3f5d6706-7b67-408d-8ba0-ec08048c45ee is not found.

{
  "error_msg" : "Job not found.",
  "error_code" : "ModelArts.2755",
  "error_solution" : "Check whether the training job in the request is valid."
}

Status Codes

Status Code	Description
200
400	Format of the body for a common error response. The following shows the returned information when a training job with ID 3f5d6706-7b67-408d-8ba0-ec08048c45ee is not found.

Error Codes

See Error Codes.

Obtaining the Artifact List of a Fine-tuning Training Task