Class: AWSCDK::Sagemaker::CfnModelCard::ModelPackageDetailsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_model_card.rb

Overview

Metadata information related to model package version.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(approval_description: nil, created_by: nil, domain: nil, inference_specification: nil, model_approval_status: nil, model_package_arn: nil, model_package_description: nil, model_package_group_name: nil, model_package_name: nil, model_package_status: nil, model_package_version: nil, source_algorithms: nil, task: nil) ⇒ ModelPackageDetailsProperty

Returns a new instance of ModelPackageDetailsProperty.

Parameters:

  • approval_description (String, nil) (defaults to: nil) —

    A description provided for the model approval.

  • created_by (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::ModelPackageCreatorProperty, nil) (defaults to: nil)
  • domain (String, nil) (defaults to: nil) —

    The machine learning domain of the model package you specified.

  • inference_specification (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::InferenceSpecificationProperty, nil) (defaults to: nil)
  • model_approval_status (String, nil) (defaults to: nil) —

    Current approval status of model package.

  • model_package_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the model package.

  • model_package_description (String, nil) (defaults to: nil) —

    A brief summary of the model package.

  • model_package_group_name (String, nil) (defaults to: nil) —

    If the model is a versioned model, the name of the model group that the versioned model belongs to.

  • model_package_name (String, nil) (defaults to: nil) —

    Name of the model package.

  • model_package_status (String, nil) (defaults to: nil) —

    Current status of model package.

  • model_package_version (Numeric, nil) (defaults to: nil) —

    Version of the model package.

  • source_algorithms (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::SourceAlgorithmProperty>, nil) (defaults to: nil)
  • task (String, nil) (defaults to: nil) —

    The machine learning task you specified that your model package accomplishes.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'sagemaker/cfn_model_card.rb', line 1545

def initialize(approval_description: nil, created_by: nil, domain: nil, inference_specification: nil, model_approval_status: nil, model_package_arn: nil, model_package_description: nil, model_package_group_name: nil, model_package_name: nil, model_package_status: nil, model_package_version: nil, source_algorithms: nil, task: nil)
  @approval_description = approval_description
  Jsii::Type.check_type(@approval_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "approvalDescription") unless @approval_description.nil?
  @created_by = created_by.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::ModelPackageCreatorProperty.new(**created_by.transform_keys(&:to_sym)) : created_by
  Jsii::Type.check_type(@created_by, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLk1vZGVsUGFja2FnZUNyZWF0b3JQcm9wZXJ0eSJ9XX19")), "createdBy") unless @created_by.nil?
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil?
  @inference_specification = inference_specification.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::InferenceSpecificationProperty.new(**inference_specification.transform_keys(&:to_sym)) : inference_specification
  Jsii::Type.check_type(@inference_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkluZmVyZW5jZVNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "inferenceSpecification") unless @inference_specification.nil?
  @model_approval_status = model_approval_status
  Jsii::Type.check_type(@model_approval_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelApprovalStatus") unless @model_approval_status.nil?
  @model_package_arn = model_package_arn
  Jsii::Type.check_type(@model_package_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPackageArn") unless @model_package_arn.nil?
  @model_package_description = model_package_description
  Jsii::Type.check_type(@model_package_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPackageDescription") unless @model_package_description.nil?
  @model_package_group_name = model_package_group_name
  Jsii::Type.check_type(@model_package_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPackageGroupName") unless @model_package_group_name.nil?
  @model_package_name = model_package_name
  Jsii::Type.check_type(@model_package_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPackageName") unless @model_package_name.nil?
  @model_package_status = model_package_status
  Jsii::Type.check_type(@model_package_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelPackageStatus") unless @model_package_status.nil?
  @model_package_version = model_package_version
  Jsii::Type.check_type(@model_package_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "modelPackageVersion") unless @model_package_version.nil?
  @source_algorithms = source_algorithms
  Jsii::Type.check_type(@source_algorithms, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbk1vZGVsQ2FyZC5Tb3VyY2VBbGdvcml0aG1Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "sourceAlgorithms") unless @source_algorithms.nil?
  @task = task
  Jsii::Type.check_type(@task, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "task") unless @task.nil?
end

Instance Attribute Details

#approval_description ⇒ String? (readonly)

A description provided for the model approval.

Returns:

  • (String, nil)

See Also:



1578
1579
1580
 
# File 'sagemaker/cfn_model_card.rb', line 1578

def approval_description
  @approval_description
end

#created_by ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



1581
1582
1583
 
# File 'sagemaker/cfn_model_card.rb', line 1581

def created_by
  @created_by
end

#domain ⇒ String? (readonly)

The machine learning domain of the model package you specified.

Common machine learning domains include computer vision and natural language processing.

Returns:

  • (String, nil)

See Also:



1588
1589
1590
 
# File 'sagemaker/cfn_model_card.rb', line 1588

def domain
  @domain
end

#inference_specification ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



1591
1592
1593
 
# File 'sagemaker/cfn_model_card.rb', line 1591

def inference_specification
  @inference_specification
end

#model_approval_status ⇒ String? (readonly)

Current approval status of model package.

Returns:

  • (String, nil)

See Also:



1596
1597
1598
 
# File 'sagemaker/cfn_model_card.rb', line 1596

def model_approval_status
  @model_approval_status
end

#model_package_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the model package.

Returns:

  • (String, nil)

See Also:



1601
1602
1603
 
# File 'sagemaker/cfn_model_card.rb', line 1601

def model_package_arn
  @model_package_arn
end

#model_package_description ⇒ String? (readonly)

A brief summary of the model package.

Returns:

  • (String, nil)

See Also:



1606
1607
1608
 
# File 'sagemaker/cfn_model_card.rb', line 1606

def model_package_description
  @model_package_description
end

#model_package_group_name ⇒ String? (readonly)

If the model is a versioned model, the name of the model group that the versioned model belongs to.

Returns:

  • (String, nil)

See Also:



1611
1612
1613
 
# File 'sagemaker/cfn_model_card.rb', line 1611

def model_package_group_name
  @model_package_group_name
end

#model_package_name ⇒ String? (readonly)

Name of the model package.

Returns:

  • (String, nil)

See Also:



1616
1617
1618
 
# File 'sagemaker/cfn_model_card.rb', line 1616

def model_package_name
  @model_package_name
end

#model_package_status ⇒ String? (readonly)

Current status of model package.

Returns:

  • (String, nil)

See Also:



1621
1622
1623
 
# File 'sagemaker/cfn_model_card.rb', line 1621

def model_package_status
  @model_package_status
end

#model_package_version ⇒ Numeric? (readonly)

Version of the model package.

Returns:

  • (Numeric, nil)

See Also:



1626
1627
1628
 
# File 'sagemaker/cfn_model_card.rb', line 1626

def model_package_version
  @model_package_version
end

#source_algorithms ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



1629
1630
1631
 
# File 'sagemaker/cfn_model_card.rb', line 1629

def source_algorithms
  @source_algorithms
end

#task ⇒ String? (readonly)

The machine learning task you specified that your model package accomplishes.

Common machine learning tasks include object detection and image classification.

Returns:

  • (String, nil)

See Also:



1636
1637
1638
 
# File 'sagemaker/cfn_model_card.rb', line 1636

def task
  @task
end

Class Method Details

.jsii_properties ⇒ Object 



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
 
# File 'sagemaker/cfn_model_card.rb', line 1638

def self.jsii_properties
  {
    :approval_description => "approvalDescription",
    :created_by => "createdBy",
    :domain => "domain",
    :inference_specification => "inferenceSpecification",
    :model_approval_status => "modelApprovalStatus",
    :model_package_arn => "modelPackageArn",
    :model_package_description => "modelPackageDescription",
    :model_package_group_name => "modelPackageGroupName",
    :model_package_name => "modelPackageName",
    :model_package_status => "modelPackageStatus",
    :model_package_version => "modelPackageVersion",
    :source_algorithms => "sourceAlgorithms",
    :task => "task",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'sagemaker/cfn_model_card.rb', line 1656

def to_jsii
  result = {}
  result.merge!({
    "approvalDescription" => @approval_description,
    "createdBy" => @created_by,
    "domain" => @domain,
    "inferenceSpecification" => @inference_specification,
    "modelApprovalStatus" => @model_approval_status,
    "modelPackageArn" => @model_package_arn,
    "modelPackageDescription" => @model_package_description,
    "modelPackageGroupName" => @model_package_group_name,
    "modelPackageName" => @model_package_name,
    "modelPackageStatus" => @model_package_status,
    "modelPackageVersion" => @model_package_version,
    "sourceAlgorithms" => @source_algorithms,
    "task" => @task,
  })
  result.compact
end