Help Center> ModelArts> SDK Reference> Training Management (Old Version)> Visualization Jobs> Modifying the Description of a Visualization Job
Updated on 2024-03-21 GMT+08:00

Modifying the Description of a Visualization 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 visualization job based on the specified visualization_id.
    1
    2
    3
    4
    5
    from modelarts.session import Session
    from modelarts.estimator import VisualizationJob
    session = Session()
    job = VisualizationJob(modelarts_session=session, visualization_id='8992')
    job_description = job.update_visualization_job(job_desc='update visualization job')
    
  • Method 2: Modify the description of the visualization job created in Creating a Visualization Job.
    1
    job_description = job_visualization_instance.update_visualization_job(job_desc='update visualization job')
    
  • Method 3: Modify the description of a visualization job object returned in Querying the List of Visualization Job Objects.
    1
    job_description = job_visualization_instance_list[0].update_visualization_job(job_desc='update visualization job')
    

Parameters

Table 1 VisualizationJob request parameters

Parameter

Mandatory

Type

Description

modelarts_session

Yes

Object

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

visualization_id

Yes

String

ID of a visualization job

Table 2 update_visualization_job request parameters

Parameter

Mandatory

Type

Description

job_desc

Yes

String

Description of a visualization job. The value is a string of 0 to 256 characters.

Table 3 update_visualization_job 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 Codes.

This parameter is not included when the API call succeeds.

is_success

Boolean

Whether the API call succeeds