Class ExplanationMetadata (0.4.0)

publicfinalclass ExplanationMetadataextendsGeneratedMessageV3implementsExplanationMetadataOrBuilder

Metadata describing the Model's input and output for explanation.

Protobuf type google.cloud.vertexai.v1.ExplanationMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplanationMetadata

Implements

ExplanationMetadataOrBuilder

Inherited Members

publicstaticfinalintFEATURE_ATTRIBUTIONS_SCHEMA_URI_FIELD_NUMBER

publicstaticfinalintINPUTS_FIELD_NUMBER

publicstaticfinalintLATENT_SPACE_SOURCE_FIELD_NUMBER

publicstaticfinalintOUTPUTS_FIELD_NUMBER

publicstaticExplanationMetadatagetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticExplanationMetadata.BuildernewBuilder()

publicstaticExplanationMetadata.BuildernewBuilder(ExplanationMetadataprototype)

publicstaticExplanationMetadataparseDelimitedFrom(InputStreaminput)

publicstaticExplanationMetadataparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplanationMetadataparseFrom(byte[]data)

publicstaticExplanationMetadataparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticExplanationMetadataparseFrom(ByteStringdata)

publicstaticExplanationMetadataparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticExplanationMetadataparseFrom(CodedInputStreaminput)

publicstaticExplanationMetadataparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplanationMetadataparseFrom(InputStreaminput)

publicstaticExplanationMetadataparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticExplanationMetadataparseFrom(ByteBufferdata)

publicstaticExplanationMetadataparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<ExplanationMetadata>parser()

publicbooleancontainsInputs(Stringkey)

Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature.

An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI.

For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature).

For custom images, the key must match with the key in instance.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

publicbooleancontainsOutputs(Stringkey)

Required. Map from output names to output metadata.

For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters.

For custom images, keys are the name of the output field in the prediction to be explained.

Currently only one key is allowed.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicExplanationMetadatagetDefaultInstanceForType()

publicStringgetFeatureAttributionsSchemaUri()

Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string feature_attributions_schema_uri = 3;

publicByteStringgetFeatureAttributionsSchemaUriBytes()

Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string feature_attributions_schema_uri = 3;

publicMap<String,ExplanationMetadata.InputMetadata>getInputs()

Use #getInputsMap() instead.

publicintgetInputsCount()

Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature.

An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI.

For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature).

For custom images, the key must match with the key in instance.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

publicMap<String,ExplanationMetadata.InputMetadata>getInputsMap()

Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature.

An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI.

For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature).

For custom images, the key must match with the key in instance.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

publicExplanationMetadata.InputMetadatagetInputsOrDefault(Stringkey,ExplanationMetadata.InputMetadatadefaultValue)

Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature.

An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI.

For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature).

For custom images, the key must match with the key in instance.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

publicExplanationMetadata.InputMetadatagetInputsOrThrow(Stringkey)

Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature.

An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI.

For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature).

For custom images, the key must match with the key in instance.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata> inputs = 1 [(.google.api.field_behavior) = REQUIRED];

publicStringgetLatentSpaceSource()

Name of the source to generate embeddings for example based explanations.

string latent_space_source = 5;

publicByteStringgetLatentSpaceSourceBytes()

Name of the source to generate embeddings for example based explanations.

string latent_space_source = 5;

publicMap<String,ExplanationMetadata.OutputMetadata>getOutputs()

Use #getOutputsMap() instead.

publicintgetOutputsCount()

Required. Map from output names to output metadata.

For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters.

For custom images, keys are the name of the output field in the prediction to be explained.

Currently only one key is allowed.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];

publicMap<String,ExplanationMetadata.OutputMetadata>getOutputsMap()

Required. Map from output names to output metadata.

For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters.

For custom images, keys are the name of the output field in the prediction to be explained.

Currently only one key is allowed.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];

publicExplanationMetadata.OutputMetadatagetOutputsOrDefault(Stringkey,ExplanationMetadata.OutputMetadatadefaultValue)

Required. Map from output names to output metadata.

For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters.

For custom images, keys are the name of the output field in the prediction to be explained.

Currently only one key is allowed.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];

publicExplanationMetadata.OutputMetadatagetOutputsOrThrow(Stringkey)

Required. Map from output names to output metadata.

For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters.

For custom images, keys are the name of the output field in the prediction to be explained.

Currently only one key is allowed.

map<string, .google.cloud.vertexai.v1.ExplanationMetadata.OutputMetadata> outputs = 2 [(.google.api.field_behavior) = REQUIRED];

publicParser<ExplanationMetadata>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldinternalGetMapField(intnumber)

GeneratedMessageV3.internalGetMapField(int fieldNumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicExplanationMetadata.BuildernewBuilderForType()

protectedExplanationMetadata.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicExplanationMetadata.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)