Class: AWSCDK::Sagemaker::CfnModelCard::ModelOverviewProperty

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

Overview

An overview about the model.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(algorithm_type: nil, inference_environment: nil, model_artifact: nil, model_creator: nil, model_description: nil, model_id: nil, model_name: nil, model_owner: nil, model_version: nil, problem_type: nil) ⇒ ModelOverviewProperty

Returns a new instance of ModelOverviewProperty.

Parameters:

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

    The algorithm used to solve the problem.

  • inference_environment (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnModelCard::InferenceEnvironmentProperty, nil) (defaults to: nil) —

    An overview about model inference.

  • model_artifact (Array<String>, nil) (defaults to: nil) —

    The location of the model artifact.

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

    The creator of the model.

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

    A description of the model.

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

    The SageMaker AI Model ARN or non- SageMaker AI Model ID.

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

    The name of the model.

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

    The owner of the model.

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

    The version of the model.

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

    The problem being solved with the model.



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'sagemaker/cfn_model_card.rb', line 1388

def initialize(algorithm_type: nil, inference_environment: nil, model_artifact: nil, model_creator: nil, model_description: nil, model_id: nil, model_name: nil, model_owner: nil, model_version: nil, problem_type: nil)
  @algorithm_type = algorithm_type
  Jsii::Type.check_type(@algorithm_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "algorithmType") unless @algorithm_type.nil?
  @inference_environment = inference_environment.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnModelCard::InferenceEnvironmentProperty.new(**inference_environment.transform_keys(&:to_sym)) : inference_environment
  Jsii::Type.check_type(@inference_environment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuTW9kZWxDYXJkLkluZmVyZW5jZUVudmlyb25tZW50UHJvcGVydHkifV19fQ==")), "inferenceEnvironment") unless @inference_environment.nil?
  @model_artifact = model_artifact
  Jsii::Type.check_type(@model_artifact, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "modelArtifact") unless @model_artifact.nil?
  @model_creator = model_creator
  Jsii::Type.check_type(@model_creator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelCreator") unless @model_creator.nil?
  @model_description = model_description
  Jsii::Type.check_type(@model_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelDescription") unless @model_description.nil?
  @model_id = model_id
  Jsii::Type.check_type(@model_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelId") unless @model_id.nil?
  @model_name = model_name
  Jsii::Type.check_type(@model_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelName") unless @model_name.nil?
  @model_owner = model_owner
  Jsii::Type.check_type(@model_owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelOwner") unless @model_owner.nil?
  @model_version = model_version
  Jsii::Type.check_type(@model_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "modelVersion") unless @model_version.nil?
  @problem_type = problem_type
  Jsii::Type.check_type(@problem_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "problemType") unless @problem_type.nil?
end

Instance Attribute Details

#algorithm_type ⇒ String? (readonly)

The algorithm used to solve the problem.

Returns:

  • (String, nil)

See Also:



1415
1416
1417
 
# File 'sagemaker/cfn_model_card.rb', line 1415

def algorithm_type
  @algorithm_type
end

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

An overview about model inference.

Returns:

See Also:



1420
1421
1422
 
# File 'sagemaker/cfn_model_card.rb', line 1420

def inference_environment
  @inference_environment
end

#model_artifact ⇒ Array<String>? (readonly)

The location of the model artifact.

Returns:

  • (Array<String>, nil)

See Also:



1425
1426
1427
 
# File 'sagemaker/cfn_model_card.rb', line 1425

def model_artifact
  @model_artifact
end

#model_creator ⇒ String? (readonly)

The creator of the model.

Returns:

  • (String, nil)

See Also:



1430
1431
1432
 
# File 'sagemaker/cfn_model_card.rb', line 1430

def model_creator
  @model_creator
end

#model_description ⇒ String? (readonly)

A description of the model.

Returns:

  • (String, nil)

See Also:



1435
1436
1437
 
# File 'sagemaker/cfn_model_card.rb', line 1435

def model_description
  @model_description
end

#model_id ⇒ String? (readonly)

The SageMaker AI Model ARN or non- SageMaker AI Model ID.

Returns:

  • (String, nil)

See Also:



1440
1441
1442
 
# File 'sagemaker/cfn_model_card.rb', line 1440

def model_id
  @model_id
end

#model_name ⇒ String? (readonly)

The name of the model.

Returns:

  • (String, nil)

See Also:



1445
1446
1447
 
# File 'sagemaker/cfn_model_card.rb', line 1445

def model_name
  @model_name
end

#model_owner ⇒ String? (readonly)

The owner of the model.

Returns:

  • (String, nil)

See Also:



1450
1451
1452
 
# File 'sagemaker/cfn_model_card.rb', line 1450

def model_owner
  @model_owner
end

#model_version ⇒ Numeric? (readonly)

The version of the model.

Returns:

  • (Numeric, nil)

See Also:



1455
1456
1457
 
# File 'sagemaker/cfn_model_card.rb', line 1455

def model_version
  @model_version
end

#problem_type ⇒ String? (readonly)

The problem being solved with the model.

Returns:

  • (String, nil)

See Also:



1460
1461
1462
 
# File 'sagemaker/cfn_model_card.rb', line 1460

def problem_type
  @problem_type
end

Class Method Details

.jsii_properties ⇒ Object 



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
 
# File 'sagemaker/cfn_model_card.rb', line 1462

def self.jsii_properties
  {
    :algorithm_type => "algorithmType",
    :inference_environment => "inferenceEnvironment",
    :model_artifact => "modelArtifact",
    :model_creator => "modelCreator",
    :model_description => "modelDescription",
    :model_id => "modelId",
    :model_name => "modelName",
    :model_owner => "modelOwner",
    :model_version => "modelVersion",
    :problem_type => "problemType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'sagemaker/cfn_model_card.rb', line 1477

def to_jsii
  result = {}
  result.merge!({
    "algorithmType" => @algorithm_type,
    "inferenceEnvironment" => @inference_environment,
    "modelArtifact" => @model_artifact,
    "modelCreator" => @model_creator,
    "modelDescription" => @model_description,
    "modelId" => @model_id,
    "modelName" => @model_name,
    "modelOwner" => @model_owner,
    "modelVersion" => @model_version,
    "problemType" => @problem_type,
  })
  result.compact
end