ILearningModelVariableDescriptorPreview.IsRequired Property

Reference

Definition

Namespace:: Windows.AI.MachineLearning.Preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Deprecated. Gets whether the variable is required or optional.

public:
 property bool IsRequired { bool get(); };

bool IsRequired();

/// [get: Windows.Foundation.Metadata.Deprecated("Use ILearningModelFeatureDescriptor instead of ILearningModelVariableDescriptorPreview. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 131072, "Windows.AI.MachineLearning.Preview.MachineLearningPreviewContract")]
bool IsRequired();

public bool IsRequired { get; }

public bool IsRequired { [Windows.Foundation.Metadata.Deprecated("Use ILearningModelFeatureDescriptor instead of ILearningModelVariableDescriptorPreview. For more info, see MSDN.", Windows.Foundation.Metadata.DeprecationType.Deprecate, 131072, "Windows.AI.MachineLearning.Preview.MachineLearningPreviewContract")] get; }

var boolean = iLearningModelVariableDescriptorPreview.isRequired;

Public ReadOnly Property IsRequired As Boolean

Property Value

Boolean

bool

True if the variable is required; otherwise false.

Attributes: DeprecatedAttribute

Examples

public void Evaluator(LearningModelPreview model)
{
	// Retrieve the first input feature which is an image
    ILearningModelVariableDescriptorPreview inputImageFeatureDescription = model.Description.InputFeatures.FirstOrDefault(feature=>feature.ModelFeatureKind == LearningModelFeatureKindPreview.Image);

    ImageVariableDescriptorPreview imageDescriptor = (ImageVariableDescriptorPreview)inputImageFeatureDescription;

	//Verify if the input feature is required or optional.
    if (imageDescriptor.IsRequired == true)
    {
        Console.WriteLine($"Input Feature Name: {imageDescriptor.Name} is required.");
    }
 }

Remarks

Warning

This is a deprecated API. Please use the Windows.AI.MachineLearning namespace instead.

Applies to

Share via