ALIYUN::PAI::Experiment - Resource Orchestration Service

ALIYUN::PAI::Experiment is used to create an experiment.

Syntax

{
  "Type": "ALIYUN::PAI::Experiment",
  "Properties": {
    "ArtifactUri": String,
    "ExperimentName": String,
    "WorkspaceId": String,
    "Accessibility": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ArtifactUri	String	Yes	No	The default artifact output path of all tasks associated with the experiment.	Only Object Storage Service (OSS) paths are supported.
ExperimentName	String	Yes	Yes	The name of the experiment.	The name must meet the following requirements: The name must start with a letter. It can contain letters, digits, underscores (_), and hyphens (-). It must be 1 to 63 characters in length.
WorkspaceId	String	Yes	No	The ID of the workspace.	None.
Accessibility	String	No	Yes	The visible scale.	Valid values: PRIVATE: The experiment is visible only to the creator account and the Alibaba Cloud account. PUBLIC: The experiment is visible to all accounts.

Return values

Fn::GetAtt

Accessibility: the visible scale.
ArtifactUri: the default artifact output path of all tasks associated with the experiment.
OwnerId: the ID of the Alibaba Cloud account.
ExperimentName: the name of the experiment.
UserId: the ID of the creator account.
ExperimentId: the ID of the experiment.
TensorboardLogUri: the default OSS storage path of TensorBoard logs used by the experiment.
CreateTime: the creation time of the experiment.
WorkspaceId: the ID of the workspace.
Labels: the tags added to the experiment.
GmtModifiedTime: the update time of the experiment.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Accessibility:
    Type: String
    Description:
      en: Experimental Visibility.
    AllowedValues:
      - PRIVATE
      - PUBLIC
    Required: false
  ArtifactUri:
    Type: String
    Description:
      en: ArtifactUri is default OSS storage path of the output of trials in the experiment.
    Required: true
  ExperimentName:
    Type: String
    Description:
      en: Name is the name of the experiment, unique in a namespace.
    Required: true
  WorkspaceId:
    Type: String
    Description:
      en: WorkspaceId is the workspace id which contains the experiment.
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::PAI::Experiment
    Properties:
      Accessibility:
        Ref: Accessibility
      ArtifactUri:
        Ref: ArtifactUri
      ExperimentName:
        Ref: ExperimentName
      WorkspaceId:
        Ref: WorkspaceId
Outputs:
  Accessibility:
    Description: Experimental Visibility.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Accessibility
  ArtifactUri:
    Description: ArtifactUri is default OSS storage path of the output of trials in the experiment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ArtifactUri
  OwnerId:
    Description: OwnerId is the user account id which this entity belongs to.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - OwnerId
  ExperimentName:
    Description: Name is the name of the experiment, unique in a namespace.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ExperimentName
  UserId:
    Description: UserId is the user account id which created this entity.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UserId
  ExperimentId:
    Description: ExperimentId is globally unique identifier of the experiment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ExperimentId
  TensorboardLogUri:
    Description: TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TensorboardLogUri
  CreateTime:
    Description: GmtCreateTime is time when this entity is created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  WorkspaceId:
    Description: WorkspaceId is the workspace id which contains the experiment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WorkspaceId
  Labels:
    Description: Labels are tags of the experiment.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Labels
  GmtModifiedTime:
    Description: GmtModifiedTime is time when this entity is modified.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GmtModifiedTime

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Accessibility": {
      "Type": "String",
      "Description": {
        "en": "Experimental Visibility."
      },
      "AllowedValues": [
        "PRIVATE",
        "PUBLIC"
      ],
      "Required": false
    },
    "ArtifactUri": {
      "Type": "String",
      "Description": {
        "en": "ArtifactUri is default OSS storage path of the output of trials in the experiment."
      },
      "Required": true
    },
    "ExperimentName": {
      "Type": "String",
      "Description": {
        "en": "Name is the name of the experiment, unique in a namespace."
      },
      "Required": true
    },
    "WorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "WorkspaceId is the workspace id which contains the experiment."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAI::Experiment",
      "Properties": {
        "Accessibility": {
          "Ref": "Accessibility"
        },
        "ArtifactUri": {
          "Ref": "ArtifactUri"
        },
        "ExperimentName": {
          "Ref": "ExperimentName"
        },
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "Accessibility": {
      "Description": "Experimental Visibility.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Accessibility"
        ]
      }
    },
    "ArtifactUri": {
      "Description": "ArtifactUri is default OSS storage path of the output of trials in the experiment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ArtifactUri"
        ]
      }
    },
    "OwnerId": {
      "Description": "OwnerId is the user account id which this entity belongs to.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "OwnerId"
        ]
      }
    },
    "ExperimentName": {
      "Description": "Name is the name of the experiment, unique in a namespace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ExperimentName"
        ]
      }
    },
    "UserId": {
      "Description": "UserId is the user account id which created this entity.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UserId"
        ]
      }
    },
    "ExperimentId": {
      "Description": "ExperimentId is globally unique identifier of the experiment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ExperimentId"
        ]
      }
    },
    "TensorboardLogUri": {
      "Description": "TensorboardLogUri is the default OSS storage path of tensorboard log of trials in the experiment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TensorboardLogUri"
        ]
      }
    },
    "CreateTime": {
      "Description": "GmtCreateTime is time when this entity is created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "WorkspaceId": {
      "Description": "WorkspaceId is the workspace id which contains the experiment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkspaceId"
        ]
      }
    },
    "Labels": {
      "Description": "Labels are tags of the experiment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Labels"
        ]
      }
    },
    "GmtModifiedTime": {
      "Description": "GmtModifiedTime is time when this entity is modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GmtModifiedTime"
        ]
      }
    }
  }
}