Help Center/ ModelArts/ SDK Reference/ Training Management/ Training Jobs/ Modifying the Description of a Training Job
Updated on 2025-08-20 GMT+08:00
View PDF

Modifying the Description of a Training Job

Sample Code

In ModelArts notebook, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see Session Authentication.

  • Method 1: Use the specified job_id. 
    from modelarts.session import Session
from modelarts.estimatorV2 import Estimator
session = Session()
estimator = Estimator(session=session, job_id="your job id")
estimator.update_job_configs(description="update job description")
  • Method 2: Use the training job created in Creating a Training Job. 
    job_instance.update_job_configs(description="update job description fourth")

Parameters

Table 1 Estimator request parameters

Parameter

Mandatory

Type

Description

session

Yes

Object

Session object. For details about the initialization method, see Session Authentication.

job_id

Yes

String

ID of a training job. You can obtain job_id using the training job created in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Obtaining Training Jobs.
Table 2 update_job_configs request parameters

Parameter

Mandatory

Type

Description

description

Yes

String

Description of the training job to be modified

There is no response for successfully calling an API.

Table 3 Response for the failure to call a training API

Parameter

Type

Description

error_msg

String

Error message when calling an API failed. This parameter is unavailable if an API is successfully called.

error_code

String

Error code when calling an API failed. For details, see "Error Codes" in ModelArts API Reference. This parameter is unavailable if an API is successfully called.

error_solution

String

Solution to an API calling failure. This parameter is unavailable if an API is successfully called.
Parent topic: Training Jobs