Interface ICfnModelExplainabilityJobDefinitionProps
Properties for defining a CfnModelExplainabilityJobDefinition
.
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public interface ICfnModelExplainabilityJobDefinitionProps
Syntax (vb)
Public Interface ICfnModelExplainabilityJobDefinitionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var json;
var cfnModelExplainabilityJobDefinitionProps = new CfnModelExplainabilityJobDefinitionProps {
JobResources = new MonitoringResourcesProperty {
ClusterConfig = new ClusterConfigProperty {
InstanceCount = 123,
InstanceType = "instanceType",
VolumeSizeInGb = 123,
// the properties below are optional
VolumeKmsKeyId = "volumeKmsKeyId"
}
},
ModelExplainabilityAppSpecification = new ModelExplainabilityAppSpecificationProperty {
ConfigUri = "configUri",
ImageUri = "imageUri",
// the properties below are optional
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
}
},
ModelExplainabilityJobInput = new ModelExplainabilityJobInputProperty {
BatchTransformInput = new BatchTransformInputProperty {
DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
DatasetFormat = new DatasetFormatProperty {
Csv = new CsvProperty {
Header = false
},
Json = json,
Parquet = false
},
LocalPath = "localPath",
// the properties below are optional
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
},
EndpointInput = new EndpointInputProperty {
EndpointName = "endpointName",
LocalPath = "localPath",
// the properties below are optional
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
}
},
ModelExplainabilityJobOutputConfig = new MonitoringOutputConfigProperty {
MonitoringOutputs = new [] { new MonitoringOutputProperty {
S3Output = new S3OutputProperty {
LocalPath = "localPath",
S3Uri = "s3Uri",
// the properties below are optional
S3UploadMode = "s3UploadMode"
}
} },
// the properties below are optional
KmsKeyId = "kmsKeyId"
},
RoleArn = "roleArn",
// the properties below are optional
EndpointName = "endpointName",
JobDefinitionName = "jobDefinitionName",
ModelExplainabilityBaselineConfig = new ModelExplainabilityBaselineConfigProperty {
BaseliningJobName = "baseliningJobName",
ConstraintsResource = new ConstraintsResourceProperty {
S3Uri = "s3Uri"
}
},
NetworkConfig = new NetworkConfigProperty {
EnableInterContainerTrafficEncryption = false,
EnableNetworkIsolation = false,
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
},
StoppingCondition = new StoppingConditionProperty {
MaxRuntimeInSeconds = 123
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
EndpointName |
|
JobDefinitionName | The name of the model explainability job definition. |
JobResources | Identifies the resources to deploy for a monitoring job. |
ModelExplainabilityAppSpecification | Configures the model explainability job to run a specified Docker container image. |
ModelExplainabilityBaselineConfig | The baseline configuration for a model explainability job. |
ModelExplainabilityJobInput | Inputs for the model explainability job. |
ModelExplainabilityJobOutputConfig | The output configuration for monitoring jobs. |
NetworkConfig | Networking options for a model explainability job. |
RoleArn | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
StoppingCondition | A time limit for how long the monitoring job is allowed to run before stopping. |
Tags | An array of key-value pairs to apply to this resource. |
Properties
EndpointName
AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName
.
virtual string EndpointName { get; }
Property Value
System.String
Remarks
JobDefinitionName
The name of the model explainability job definition.
virtual string JobDefinitionName { get; }
Property Value
System.String
Remarks
The name must be unique within an AWS Region in the AWS account.
JobResources
Identifies the resources to deploy for a monitoring job.
object JobResources { get; }
Property Value
System.Object
Remarks
ModelExplainabilityAppSpecification
Configures the model explainability job to run a specified Docker container image.
object ModelExplainabilityAppSpecification { get; }
Property Value
System.Object
Remarks
ModelExplainabilityBaselineConfig
The baseline configuration for a model explainability job.
virtual object ModelExplainabilityBaselineConfig { get; }
Property Value
System.Object
Remarks
ModelExplainabilityJobInput
Inputs for the model explainability job.
object ModelExplainabilityJobInput { get; }
Property Value
System.Object
Remarks
ModelExplainabilityJobOutputConfig
The output configuration for monitoring jobs.
object ModelExplainabilityJobOutputConfig { get; }
Property Value
System.Object
Remarks
NetworkConfig
Networking options for a model explainability job.
virtual object NetworkConfig { get; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
string RoleArn { get; }
Property Value
System.String
Remarks
StoppingCondition
A time limit for how long the monitoring job is allowed to run before stopping.
virtual object StoppingCondition { get; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]