Interface ExplanationMetadata.InputMetadataOrBuilder (0.5.0)

public static interface ExplanationMetadata.InputMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDenseShapeTensorName()

public abstract String getDenseShapeTensorName()

Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.

string dense_shape_tensor_name = 7;

Returns
Type	Description
`String`	The denseShapeTensorName.

getDenseShapeTensorNameBytes()

public abstract ByteString getDenseShapeTensorNameBytes()

string dense_shape_tensor_name = 7;

Returns
Type	Description
`ByteString`	The bytes for denseShapeTensorName.

getEncodedBaselines(int index)

public abstract Value getEncodedBaselines(int index)

A list of baselines for the encoded tensor.

The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.

repeated .google.protobuf.Value encoded_baselines = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Value`

getEncodedBaselinesCount()

public abstract int getEncodedBaselinesCount()

A list of baselines for the encoded tensor.

The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.

repeated .google.protobuf.Value encoded_baselines = 10;

Returns
Type	Description
`int`

getEncodedBaselinesList()

public abstract List<Value> getEncodedBaselinesList()

A list of baselines for the encoded tensor.

The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.

repeated .google.protobuf.Value encoded_baselines = 10;

Returns
Type	Description
`List<Value>`

getEncodedBaselinesOrBuilder(int index)

public abstract ValueOrBuilder getEncodedBaselinesOrBuilder(int index)

A list of baselines for the encoded tensor.

The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.

repeated .google.protobuf.Value encoded_baselines = 10;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ValueOrBuilder`

getEncodedBaselinesOrBuilderList()

public abstract List<? extends ValueOrBuilder> getEncodedBaselinesOrBuilderList()

A list of baselines for the encoded tensor.

The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.

repeated .google.protobuf.Value encoded_baselines = 10;

Returns
Type	Description
`List<? extends com.google.protobuf.ValueOrBuilder>`

getEncodedTensorName()

public abstract String getEncodedTensorName()

Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable.

An encoded tensor is generated if the input tensor is encoded by a lookup table.

string encoded_tensor_name = 9;

Returns
Type	Description
`String`	The encodedTensorName.

getEncodedTensorNameBytes()

public abstract ByteString getEncodedTensorNameBytes()

Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable.

An encoded tensor is generated if the input tensor is encoded by a lookup table.

string encoded_tensor_name = 9;

Returns
Type	Description
`ByteString`	The bytes for encodedTensorName.

getEncoding()

public abstract ExplanationMetadata.InputMetadata.Encoding getEncoding()

Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Encoding encoding = 3;

Returns
Type	Description
`ExplanationMetadata.InputMetadata.Encoding`	The encoding.

getEncodingValue()

public abstract int getEncodingValue()

Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Encoding encoding = 3;

Returns
Type	Description
`int`	The enum numeric value on the wire for encoding.

getFeatureValueDomain()

public abstract ExplanationMetadata.InputMetadata.FeatureValueDomain getFeatureValueDomain()

The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.FeatureValueDomain feature_value_domain = 5;

Returns
Type	Description
`ExplanationMetadata.InputMetadata.FeatureValueDomain`	The featureValueDomain.

getFeatureValueDomainOrBuilder()

public abstract ExplanationMetadata.InputMetadata.FeatureValueDomainOrBuilder getFeatureValueDomainOrBuilder()

The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.FeatureValueDomain feature_value_domain = 5;

Returns
Type	Description
`ExplanationMetadata.InputMetadata.FeatureValueDomainOrBuilder`

getGroupName()

public abstract String getGroupName()

Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.

string group_name = 12;

Returns
Type	Description
`String`	The groupName.

getGroupNameBytes()

public abstract ByteString getGroupNameBytes()

string group_name = 12;

Returns
Type	Description
`ByteString`	The bytes for groupName.

getIndexFeatureMapping(int index)

public abstract String getIndexFeatureMapping(int index)

A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.

repeated string index_feature_mapping = 8;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The indexFeatureMapping at the given index.

getIndexFeatureMappingBytes(int index)

public abstract ByteString getIndexFeatureMappingBytes(int index)

A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.

repeated string index_feature_mapping = 8;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the indexFeatureMapping at the given index.

getIndexFeatureMappingCount()

public abstract int getIndexFeatureMappingCount()

A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.

repeated string index_feature_mapping = 8;

Returns
Type	Description
`int`	The count of indexFeatureMapping.

getIndexFeatureMappingList()

public abstract List<String> getIndexFeatureMappingList()

A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.

repeated string index_feature_mapping = 8;

Returns
Type	Description
`List<String>`	A list containing the indexFeatureMapping.

getIndicesTensorName()

public abstract String getIndicesTensorName()

Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.

string indices_tensor_name = 6;

Returns
Type	Description
`String`	The indicesTensorName.

getIndicesTensorNameBytes()

public abstract ByteString getIndicesTensorNameBytes()

string indices_tensor_name = 6;

Returns
Type	Description
`ByteString`	The bytes for indicesTensorName.

getInputBaselines(int index)

public abstract Value getInputBaselines(int index)

Baseline inputs for this feature.

If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions.

For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor.

For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.

repeated .google.protobuf.Value input_baselines = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Value`

getInputBaselinesCount()

public abstract int getInputBaselinesCount()

Baseline inputs for this feature.

repeated .google.protobuf.Value input_baselines = 1;

Returns
Type	Description
`int`

getInputBaselinesList()

public abstract List<Value> getInputBaselinesList()

Baseline inputs for this feature.

repeated .google.protobuf.Value input_baselines = 1;

Returns
Type	Description
`List<Value>`

getInputBaselinesOrBuilder(int index)

public abstract ValueOrBuilder getInputBaselinesOrBuilder(int index)

Baseline inputs for this feature.

repeated .google.protobuf.Value input_baselines = 1;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ValueOrBuilder`

getInputBaselinesOrBuilderList()

public abstract List<? extends ValueOrBuilder> getInputBaselinesOrBuilderList()

Baseline inputs for this feature.

repeated .google.protobuf.Value input_baselines = 1;

Returns
Type	Description
`List<? extends com.google.protobuf.ValueOrBuilder>`

getInputTensorName()

public abstract String getInputTensorName()

Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.

string input_tensor_name = 2;

Returns
Type	Description
`String`	The inputTensorName.

getInputTensorNameBytes()

public abstract ByteString getInputTensorNameBytes()

Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.

string input_tensor_name = 2;

Returns
Type	Description
`ByteString`	The bytes for inputTensorName.

getModality()

public abstract String getModality()

Modality of the feature. Valid values are: numeric, image. Defaults to numeric.

string modality = 4;

Returns
Type	Description
`String`	The modality.

getModalityBytes()

public abstract ByteString getModalityBytes()

Modality of the feature. Valid values are: numeric, image. Defaults to numeric.

string modality = 4;

Returns
Type	Description
`ByteString`	The bytes for modality.

getVisualization()

public abstract ExplanationMetadata.InputMetadata.Visualization getVisualization()

Visualization configurations for image explanation.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization visualization = 11;

Returns
Type	Description
`ExplanationMetadata.InputMetadata.Visualization`	The visualization.

getVisualizationOrBuilder()

public abstract ExplanationMetadata.InputMetadata.VisualizationOrBuilder getVisualizationOrBuilder()

Visualization configurations for image explanation.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization visualization = 11;

Returns
Type	Description
`ExplanationMetadata.InputMetadata.VisualizationOrBuilder`

hasFeatureValueDomain()

public abstract boolean hasFeatureValueDomain()

The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.FeatureValueDomain feature_value_domain = 5;

Returns
Type	Description
`boolean`	Whether the featureValueDomain field is set.

hasVisualization()

public abstract boolean hasVisualization()

Visualization configurations for image explanation.

.google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.Visualization visualization = 11;

Returns
Type	Description
`boolean`	Whether the visualization field is set.