Struct ExplanationMetadata 

#[non_exhaustive]
pub struct ExplanationMetadata {
    pub inputs: HashMap<String, InputMetadata>,
    pub outputs: HashMap<String, OutputMetadata>,
    pub feature_attributions_schema_uri: String,
    pub latent_space_source: String,
    /* private fields */
}

Available on crate features dataset-service or deployment-resource-pool-service or endpoint-service or job-service or model-service or pipeline-service only.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

inputs: HashMap<String, InputMetadata>

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.

outputs: HashMap<String, OutputMetadata>

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.

feature_attributions_schema_uri: String

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.

latent_space_source: String

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

Implementations

impl ExplanationMetadata

pub fn new() -> Self

pub fn set_inputs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<InputMetadata>,

Sets the value of inputs.

Example

use google_cloud_aiplatform_v1::model::explanation_metadata::InputMetadata;
let x = ExplanationMetadata::new().set_inputs([
    ("key0", InputMetadata::default()/* use setters */),
    ("key1", InputMetadata::default()/* use (different) setters */),
]);

pub fn set_outputs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<OutputMetadata>,

Sets the value of outputs.

Example

use google_cloud_aiplatform_v1::model::explanation_metadata::OutputMetadata;
let x = ExplanationMetadata::new().set_outputs([
    ("key0", OutputMetadata::default()/* use setters */),
    ("key1", OutputMetadata::default()/* use (different) setters */),
]);

pub fn set_feature_attributions_schema_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of feature_attributions_schema_uri.

Example

let x = ExplanationMetadata::new().set_feature_attributions_schema_uri("example");

pub fn set_latent_space_source<T: Into<String>>(self, v: T) -> Self

Sets the value of latent_space_source.

Example

let x = ExplanationMetadata::new().set_latent_space_source("example");

Trait Implementations

impl Clone for ExplanationMetadata

fn clone(&self) -> ExplanationMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExplanationMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExplanationMetadata

fn default() -> ExplanationMetadata

Returns the “default value” for a type.

impl Message for ExplanationMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExplanationMetadata

fn eq(&self, other: &ExplanationMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExplanationMetadata