ALIYUN::PAIDLC::Tensorboard - Resource Orchestration Service

ALIYUN::PAIDLC::Tensorboard is used to create a TensorBoard instance.

Syntax

{
  "Type": "ALIYUN::PAIDLC::Tensorboard",
  "Properties": {
    "MaxRunningTimeMinutes": Integer,
    "Options": String,
    "Memory": Integer,
    "SummaryPath": String,
    "SourceId": String,
    "SourceType": String,
    "WorkspaceId": String,
    "Cpu": Integer,
    "Uri": String,
    "DataSources": List,
    "SummaryRelativePath": String,
    "DataSourceType": String,
    "DisplayName": String,
    "JobId": String,
    "DataSourceId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
MaxRunningTimeMinutes	Integer	No	Yes	The maximum running duration.	Unit: minutes.
Options	String	No	No	The extended fields of the dataset. The value is in the JSON format.	Set the value to MountPath. A value of MountPath specifies the path to which the dataset is mounted. Example: `{"mountpath":"/root/data/"}`
Memory	Integer	No	No	The memory size.	Unit: GB.
SummaryPath	String	No	No	The path of the summary.	None.
SourceId	String	No	No	The source ID.	None.
SourceType	String	No	No	The source type.	Example: job.
WorkspaceId	String	Yes	No	The workspace ID.	None.
Cpu	Integer	No	No	The number of CPU cores.	None.
Uri	String	No	No	The Uniform Resource Identifier (URI) of the dataset.	Value formats: Value format when DataSourceType is set to OSS: `oss://[oss-bucket].[endpoint]/[path]`. Value format when DataSourceType is set to NAS:`nas://[nas-filesystem-id].[region]/[path]`.
DataSources	List	No	No	The configurations of the data sources.	None.
SummaryRelativePath	String	No	No	The relative path of the summary.	None.
DataSourceType	String	No	No	The dataset type.	Valid values: OSS NAS
DisplayName	String	Yes	No	The name of the TensorBoard instance.	None.
JobId	String	No	No	The job ID.	None.
DataSourceId	String	Yes	No	The dataset ID.	None.

Return values

Fn::GetAtt

TensorboardId: the ID of the TensorBoard instance.
TensorboardUrl: The URL of the TensorBoard instance.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Cpu:
    Description: CPU nuclear number.
    Type: Number
  DataSourceId:
    Description: For dataset ID, see the data set ID, see ListDataSets.
    Type: String
  DataSourceType:
    AllowedValues:
    - OSS
    - NAS
    Description: 'The type of dataset. Values: OSS,NAS'
    Type: String
  DataSources:
    Description: Data source configuration.
    Type: CommaDelimitedList
  DisplayName:
    Description: Tensorboard name.
    Type: String
  JobId:
    Description: Task ID.How to get the task ID, see Listjobs.
    Type: String
  MaxRunningTimeMinutes:
    Description: 'The longest running time, the unit is: minutes.'
    Type: Number
  Memory:
    Description: 'Memory size, the unit is: GB.'
    Type: Number
  Options:
    Description: 'The expansion field of the dataset is JSON format, which currently
      supports Mountpath: the path of custom dataset mounting.'
    Type: String
  SourceId:
    Description: Source ID.
    Type: String
  SourceType:
    Description: Source type.
    Type: String
  SummaryPath:
    Description: Summary directory.
    Type: String
  SummaryRelativePath:
    Description: Summary relative directory. Summary relative directory and Summary
      directory are mutually exclusive
    Type: String
  Uri:
    Description: 'URI of a dataset:

      When DataSourceType is OSS, the format is: OSS: // [OSS-BUCET]. [Endpoint]/[Path].

      When the DataSourceType is NAS, the format is: nas:// [nas-filesystem-id]. [Region]/[PATH].'
    Type: String
  WorkspaceId:
    Description: Work space ID.How to get working space ID, see ListworkSpaces.
    Type: String
Resources:
  Tensorboard:
    Properties:
      Cpu:
        Ref: Cpu
      DataSourceId:
        Ref: DataSourceId
      DataSourceType:
        Ref: DataSourceType
      DataSources:
        Ref: DataSources
      DisplayName:
        Ref: DisplayName
      JobId:
        Ref: JobId
      MaxRunningTimeMinutes:
        Ref: MaxRunningTimeMinutes
      Memory:
        Ref: Memory
      Options:
        Ref: Options
      SourceId:
        Ref: SourceId
      SourceType:
        Ref: SourceType
      SummaryPath:
        Ref: SummaryPath
      SummaryRelativePath:
        Ref: SummaryRelativePath
      Uri:
        Ref: Uri
      WorkspaceId:
        Ref: WorkspaceId
    Type: ALIYUN::PAIDLC::Tensorboard
Outputs:
  TensorboardId:
    Description: Tensorboard id.
    Value:
      Fn::GetAtt:
      - Tensorboard
      - TensorboardId
  TensorboardUrl:
    Description: Tensorboard url.
    Value:
      Fn::GetAtt:
      - Tensorboard
      - TensorboardUrl

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "MaxRunningTimeMinutes": {
      "Type": "Number",
      "Description": "The longest running time, the unit is: minutes."
    },
    "Options": {
      "Type": "String",
      "Description": "The expansion field of the dataset is JSON format, which currently supports Mountpath: the path of custom dataset mounting."
    },
    "Memory": {
      "Type": "Number",
      "Description": "Memory size, the unit is: GB."
    },
    "SummaryPath": {
      "Type": "String",
      "Description": "Summary directory."
    },
    "SourceId": {
      "Type": "String",
      "Description": "Source ID."
    },
    "SourceType": {
      "Type": "String",
      "Description": "Source type."
    },
    "WorkspaceId": {
      "Type": "String",
      "Description": "Work space ID.How to get working space ID, see ListworkSpaces."
    },
    "Cpu": {
      "Type": "Number",
      "Description": "CPU nuclear number."
    },
    "Uri": {
      "Type": "String",
      "Description": "URI of a dataset:\nWhen DataSourceType is OSS, the format is: OSS: // [OSS-BUCET]. [Endpoint]/[Path].\nWhen the DataSourceType is NAS, the format is: nas:// [nas-filesystem-id]. [Region]/[PATH]."
    },
    "DataSources": {
      "Type": "CommaDelimitedList",
      "Description": "Data source configuration."
    },
    "SummaryRelativePath": {
      "Type": "String",
      "Description": "Summary relative directory. Summary relative directory and Summary directory are mutually exclusive"
    },
    "DataSourceType": {
      "Type": "String",
      "Description": "The type of dataset. Values: OSS,NAS",
      "AllowedValues": [
        "OSS",
        "NAS"
      ]
    },
    "DisplayName": {
      "Type": "String",
      "Description": "Tensorboard name."
    },
    "JobId": {
      "Type": "String",
      "Description": "Task ID.How to get the task ID, see Listjobs."
    },
    "DataSourceId": {
      "Type": "String",
      "Description": "For dataset ID, see the data set ID, see ListDataSets."
    }
  },
  "Resources": {
    "Tensorboard": {
      "Type": "ALIYUN::PAIDLC::Tensorboard",
      "Properties": {
        "MaxRunningTimeMinutes": {
          "Ref": "MaxRunningTimeMinutes"
        },
        "Options": {
          "Ref": "Options"
        },
        "Memory": {
          "Ref": "Memory"
        },
        "SummaryPath": {
          "Ref": "SummaryPath"
        },
        "SourceId": {
          "Ref": "SourceId"
        },
        "SourceType": {
          "Ref": "SourceType"
        },
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        },
        "Cpu": {
          "Ref": "Cpu"
        },
        "Uri": {
          "Ref": "Uri"
        },
        "DataSources": {
          "Ref": "DataSources"
        },
        "SummaryRelativePath": {
          "Ref": "SummaryRelativePath"
        },
        "DataSourceType": {
          "Ref": "DataSourceType"
        },
        "DisplayName": {
          "Ref": "DisplayName"
        },
        "JobId": {
          "Ref": "JobId"
        },
        "DataSourceId": {
          "Ref": "DataSourceId"
        }
      }
    }
  },
  "Outputs": {
    "TensorboardId": {
      "Description": "Tensorboard id.",
      "Value": {
        "Fn::GetAtt": [
          "Tensorboard",
          "TensorboardId"
        ]
      }
    },
    "TensorboardUrl": {
      "Description": "Tensorboard url.",
      "Value": {
        "Fn::GetAtt": [
          "Tensorboard",
          "TensorboardUrl"
        ]
      }
    }
  }
}