Skip to content
v2.277.0

FunctionProperty Struct ​

Function details.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const functionProperty: sagemaker.CfnModelCard.FunctionProperty = {
  condition: 'condition',
  facet: 'facet',
  function: 'function',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

function_property = sagemaker.CfnModelCard.FunctionProperty(
    condition="condition",
    facet="facet",
    function="function"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

FunctionProperty functionProperty = FunctionProperty.builder()
        .condition("condition")
        .facet("facet")
        .function("function")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 functionProperty = new FunctionProperty {
    Condition = "condition",
    Facet = "facet",
    Function = "function"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

functionProperty := &FunctionProperty{
	Condition: jsii.String("condition"),
	Facet: jsii.String("facet"),
	Function: jsii.String("function"),
}

Properties ​

conditionoptionalstringconditionoptionalstrconditionoptionalStringConditionoptionalstringConditionoptional*string#
An optional description of any conditions of your objective function metric.
facetoptionalstringfacetoptionalstrfacetoptionalStringFacetoptionalstringFacetoptional*string#
The metric of the model's objective function.

For example, loss or rmse . The following list shows examples of the values that you can specify for the metric:

  • ACCURACY
  • AUC
  • LOSS
  • MAE
  • RMSE
functionoptionalstringfunctionoptionalstrfunctionoptionalStringFunctionoptionalstringFunctionoptional*string#
The optimization direction of the model's objective function. You must specify one of the following values:.
  • Maximize
  • Minimize