ModelExplainabilityJobDefinition

sagemaker.services.k8s.aws/v1alpha1

Type	Link
GoDoc	sagemaker-controller/apis/v1alpha1#ModelExplainabilityJobDefinition

Metadata

Property	Value
Scope	Namespaced
Kind	`ModelExplainabilityJobDefinition`
ListKind	`ModelExplainabilityJobDefinitionList`
Plural	`modelexplainabilityjobdefinitions`
Singular	`modelexplainabilityjobdefinition`

Spec

jobDefinitionName: string
jobResources: 
  clusterConfig: 
    instanceCount: integer
    instanceType: string
    volumeKMSKeyID: string
    volumeSizeInGB: integer
modelExplainabilityAppSpecification: 
  configURI: string
  environment: {}
  imageURI: string
modelExplainabilityBaselineConfig: 
  baseliningJobName: string
  constraintsResource: 
    s3URI: string
modelExplainabilityJobInput: 
  endpointInput: 
    endTimeOffset: string
    endpointName: string
    excludeFeaturesAttribute: string
    featuresAttribute: string
    inferenceAttribute: string
    localPath: string
    probabilityAttribute: string
    probabilityThresholdAttribute: number
    s3DataDistributionType: string
    s3InputMode: string
    startTimeOffset: string
modelExplainabilityJobOutputConfig: 
  kmsKeyID: string
  monitoringOutputs:
    s3Output: 
      localPath: string
      s3URI: string
      s3UploadMode: string
networkConfig: 
  enableInterContainerTrafficEncryption: boolean
  enableNetworkIsolation: boolean
  vpcConfig: 
    securityGroupIDs:
    - string
    subnets:
    - string
roleARN: string
stoppingCondition: 
  maxRuntimeInSeconds: integer
tags:
- key: string
  value: string

Field	Description
jobDefinitionName Required	string The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
jobResources Required	object Identifies the resources to deploy for a monitoring job.
jobResources.clusterConfig Optional	object Configuration for the cluster used to run model monitoring jobs.
jobResources.clusterConfig.instanceCount Optional	integer
jobResources.clusterConfig.instanceType Optional	string
jobResources.clusterConfig.volumeKMSKeyID Optional	string
jobResources.clusterConfig.volumeSizeInGB Optional	integer
modelExplainabilityAppSpecification Required	object Configures the model explainability job to run a specified Docker container image.
modelExplainabilityAppSpecification.configURI Optional	string
modelExplainabilityAppSpecification.environment Optional	object
modelExplainabilityAppSpecification.imageURI Optional	string
modelExplainabilityBaselineConfig Optional	object The baseline configuration for a model explainability job.
modelExplainabilityBaselineConfig.baseliningJobName Optional	string
modelExplainabilityBaselineConfig.constraintsResource Optional	object The constraints resource for a monitoring job.
modelExplainabilityBaselineConfig.constraintsResource.s3URI Optional	string
modelExplainabilityJobInput Required	object Inputs for the model explainability job.
modelExplainabilityJobInput.endpointInput Optional	object Input object for the endpoint
modelExplainabilityJobInput.endpointInput.endTimeOffset Optional	string
modelExplainabilityJobInput.endpointInput.endpointName Optional	string
modelExplainabilityJobInput.endpointInput.excludeFeaturesAttribute Optional	string
modelExplainabilityJobInput.endpointInput.featuresAttribute Optional	string
modelExplainabilityJobInput.endpointInput.inferenceAttribute Optional	string
modelExplainabilityJobInput.endpointInput.localPath Optional	string
modelExplainabilityJobInput.endpointInput.probabilityAttribute Optional	string
modelExplainabilityJobInput.endpointInput.probabilityThresholdAttribute Optional	number
modelExplainabilityJobInput.endpointInput.s3DataDistributionType Optional	string
modelExplainabilityJobInput.endpointInput.s3InputMode Optional	string
modelExplainabilityJobInput.endpointInput.startTimeOffset Optional	string
modelExplainabilityJobOutputConfig Required	object The output configuration for monitoring jobs.
modelExplainabilityJobOutputConfig.kmsKeyID Optional	string
modelExplainabilityJobOutputConfig.monitoringOutputs Optional	array
modelExplainabilityJobOutputConfig.monitoringOutputs.[] Required	object The output object for a monitoring job.
modelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.localPath Optional	string
modelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI Optional	string
modelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode Optional	string
networkConfig Optional	object Networking options for a model explainability job.
networkConfig.enableInterContainerTrafficEncryption Optional	boolean
networkConfig.enableNetworkIsolation Optional	boolean
networkConfig.vpcConfig Optional	object Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).
networkConfig.vpcConfig.securityGroupIDs Optional	array
networkConfig.vpcConfig.securityGroupIDs.[] Required	string
networkConfig.vpcConfig.subnets.[] Required	string
stoppingCondition Optional	object A time limit for how long the monitoring job is allowed to run before stopping.
stoppingCondition.maxRuntimeInSeconds Optional	integer
tags Optional	array (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the Amazon Web Services Billing and Cost Management User Guide.
tags.[] Required	object A tag object that consists of a key and an optional value, used to manage
metadata for SageMaker Amazon Web Services resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition

ModelExplainabilityJobDefinition

Metadata#

Spec#

Status#

Metadata

Spec

Status