InferenceComponent

sagemaker.services.k8s.aws/v1alpha1

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

Metadata

Property	Value
Scope	Namespaced
Kind	`InferenceComponent`
ListKind	`InferenceComponentList`
Plural	`inferencecomponents`
Singular	`inferencecomponent`

Spec

endpointName: string
inferenceComponentName: string
runtimeConfig: 
  copyCount: integer
specification: 
  computeResourceRequirements: 
    maxMemoryRequiredInMb: integer
    minMemoryRequiredInMb: integer
    numberOfAcceleratorDevicesRequired: number
    numberOfCPUCoresRequired: number
  container: 
    artifactURL: string
    environment: {}
    image: string
  modelName: string
  startupParameters: 
    containerStartupHealthCheckTimeoutInSeconds: integer
    modelDataDownloadTimeoutInSeconds: integer
tags:
- key: string
  value: string
variantName: string

Field	Description
endpointName Optional	string The name of an existing endpoint where you host the inference component.
inferenceComponentName Required	string A unique name to assign to the inference component.
runtimeConfig Required	object Runtime settings for a model that is deployed with an inference component.
runtimeConfig.copyCount Optional	integer
specification Required	object Details about the resources to deploy with this inference component, including the model, container, and compute resources.
specification.computeResourceRequirements Optional	object Defines the compute resources to allocate to run a model that you assign to an inference component. These resources include CPU cores, accelerators, and memory.
specification.computeResourceRequirements.maxMemoryRequiredInMb Optional	integer
specification.computeResourceRequirements.minMemoryRequiredInMb Optional	integer
specification.computeResourceRequirements.numberOfAcceleratorDevicesRequired Optional	number
specification.computeResourceRequirements.numberOfCPUCoresRequired Optional	number
specification.container Optional	object Defines a container that provides the runtime environment for a model that you deploy with an inference component.
specification.container.artifactURL Optional	string
specification.container.environment Optional	object
specification.container.image Optional	string
specification.modelName Optional	string
specification.startupParameters Optional	object Settings that take effect while the model container starts up.
specification.startupParameters.containerStartupHealthCheckTimeoutInSeconds Optional	integer
specification.startupParameters.modelDataDownloadTimeoutInSeconds Optional	integer
tags Optional	array A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference.
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
| | variantName
Optional | string
The name of an existing production variant where you host the inference component. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
endpointName: string
failureReason: string
inferenceComponentStatus: string
lastModifiedTime: string
variantName: 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
creationTime Optional	string The time when the inference component was created.
endpointName Optional	string The name of the endpoint that hosts the inference component.
failureReason Optional	string If the inference component status is Failed, the reason for the failure.
inferenceComponentStatus Optional	string The status of the inference component.
lastModifiedTime Optional	string The time when the inference component was last updated.
variantName Optional	string The name of the production variant that hosts the inference component.

InferenceComponent

Metadata#

Spec#

Status#

Metadata

Spec

Status