Class CfnModelQualityJobDefinitionPropsMixin.BatchTransformInputProperty

Input object for the batch transform job.

Inheritance

object

CfnModelQualityJobDefinitionPropsMixin.BatchTransformInputProperty

Implements

CfnModelQualityJobDefinitionPropsMixin.IBatchTransformInputProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnModelQualityJobDefinitionPropsMixin.BatchTransformInputProperty : CfnModelQualityJobDefinitionPropsMixin.IBatchTransformInputProperty

Syntax (vb)

Public Class CfnModelQualityJobDefinitionPropsMixin.BatchTransformInputProperty Implements CfnModelQualityJobDefinitionPropsMixin.IBatchTransformInputProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var batchTransformInputProperty = new BatchTransformInputProperty {
                 DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                 DatasetFormat = new DatasetFormatProperty {
                     Csv = new CsvProperty {
                         Header = false
                     },
                     Json = new JsonProperty {
                         Line = false
                     },
                     Parquet = false
                 },
                 EndTimeOffset = "endTimeOffset",
                 InferenceAttribute = "inferenceAttribute",
                 LocalPath = "localPath",
                 ProbabilityAttribute = "probabilityAttribute",
                 ProbabilityThresholdAttribute = 123,
                 S3DataDistributionType = "s3DataDistributionType",
                 S3InputMode = "s3InputMode",
                 StartTimeOffset = "startTimeOffset"
             };

Synopsis

Constructors

BatchTransformInputProperty()

Input object for the batch transform job.

Properties

DataCapturedDestinationS3Uri	The Amazon S3 location being used to capture the data.
DatasetFormat	The dataset format for your batch transform job.
EndTimeOffset	If specified, monitoring jobs subtract this time from the end time.
InferenceAttribute	The attribute of the input data that represents the ground truth label.
LocalPath	Path to the filesystem where the batch transform data is available to the container.
ProbabilityAttribute	In a classification problem, the attribute that represents the class probability.
ProbabilityThresholdAttribute	The threshold for the class probability to be evaluated as a positive result.
S3DataDistributionType	Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.
S3InputMode	Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job.
StartTimeOffset	If specified, monitoring jobs substract this time from the start time.

Constructors

BatchTransformInputProperty()

Input object for the batch transform job.

public BatchTransformInputProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var batchTransformInputProperty = new BatchTransformInputProperty {
                 DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                 DatasetFormat = new DatasetFormatProperty {
                     Csv = new CsvProperty {
                         Header = false
                     },
                     Json = new JsonProperty {
                         Line = false
                     },
                     Parquet = false
                 },
                 EndTimeOffset = "endTimeOffset",
                 InferenceAttribute = "inferenceAttribute",
                 LocalPath = "localPath",
                 ProbabilityAttribute = "probabilityAttribute",
                 ProbabilityThresholdAttribute = 123,
                 S3DataDistributionType = "s3DataDistributionType",
                 S3InputMode = "s3InputMode",
                 StartTimeOffset = "startTimeOffset"
             };

Properties

DataCapturedDestinationS3Uri

The Amazon S3 location being used to capture the data.

public string? DataCapturedDestinationS3Uri { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelqualityjobdefinition-batchtransforminput.html#cfn-sagemaker-modelqualityjobdefinition-batchtransforminput-datacaptureddestinations3uri

DatasetFormat

The dataset format for your batch transform job.

public object? DatasetFormat { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnModelQualityJobDefinitionPropsMixin.IDatasetFormatProperty

EndTimeOffset

If specified, monitoring jobs subtract this time from the end time.

public string? EndTimeOffset { get; set; }

Property Value

string

Remarks

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .

InferenceAttribute

The attribute of the input data that represents the ground truth label.

public string? InferenceAttribute { get; set; }

Property Value

string

Remarks

LocalPath

Path to the filesystem where the batch transform data is available to the container.

public string? LocalPath { get; set; }

Property Value

string

Remarks

ProbabilityAttribute

In a classification problem, the attribute that represents the class probability.

public string? ProbabilityAttribute { get; set; }

Property Value

string

Remarks

ProbabilityThresholdAttribute

The threshold for the class probability to be evaluated as a positive result.

public double? ProbabilityThresholdAttribute { get; set; }

Property Value

double?

Remarks

S3DataDistributionType

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

public string? S3DataDistributionType { get; set; }

Property Value

string

Remarks

Defaults to FullyReplicated

S3InputMode

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

public string? S3InputMode { get; set; }

Property Value

string

Remarks

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .

StartTimeOffset

If specified, monitoring jobs substract this time from the start time.

public string? StartTimeOffset { get; set; }

Property Value

string

Remarks

For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs .

Implements

CfnModelQualityJobDefinitionPropsMixin.IBatchTransformInputProperty