Help Center> ModelArts> SDK Reference> Training Management (Old Version)> Training Jobs> Modifying the Description of a Training Job

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: Modify the description of a training job based on the specified job_id. 
    1
2
3
4
5
    		 
    from modelarts.session import Session
from modelarts.estimator import Estimator
session = Session()
estimator = Estimator(modelarts_session=session, job_id="182626")
job_description = estimator.update_job_description(description='update description')
  • Method 2: Modify the description of the training job created in Creating a Training Job. 
    1
    		 
    job_description = job_instance.update_job_description(description='update description')
  • Method 3: Modify the description of a training job version object returned in Querying the List of Training Job Versions. 
    1
    		 
    job_description = job_version_instance_list[0].update_job_description(description='update description')

Parameters

Table 1 Estimator request parameters

Parameter

Mandatory

Type

Description

modelarts_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 query job_id using the training job object generated in Creating a Training Job, for example, job_instance.job_id, or from the response obtained in Querying the List of Training Jobs.
Table 2 update_job_description request parameters

Parameter

Mandatory

Type

Description

description

Yes

String

Description of the training job to be modified
Table 3 update_job_description response parameters

Parameter

Type

Description

error_msg

String

Error message when the API call fails.

This parameter is not included when the API call succeeds.

error_code

String

Error code when the API fails to be called. For details, see Error Code.

This parameter is not included when the API call succeeds.

is_success

Boolean

Whether the API call succeeds
Parent topic: Training Jobs