Join us at DevFest for Ukraine June 14-15 Online Register now

tfma.metrics.StandardMetricInputs

Standard inputs used by most metric computations.

StandardMetricInputs is a wrapper around Extracts where only the extracts keys used by one or more ExtractsPreprocessors will be present.

extracts Reference to existing extracts to use.
**kwargs Name/value pairs to create new extracts from. Only one of either extracts or kwargs should be used.

attributions Returns tfma.ATTRIBUTIONS_KEY extract.
example_weight Same as example_weights (DEPRECATED - use example_weights).
example_weights Returns tfma.EXAMPLE_WEIGHTS_KEY extract.
features Returns tfma.FEATURES_KEY extract.
inputs Returns tfma.INPUT_KEY extract.
label Same as labels (DEPRECATED - use labels).
labels Returns tfma.LABELS_KEY extract.
prediction Same as predictions (DEPRECATED - use predictions).
predictions Returns tfma.PREDICTIONS_KEY extract.
transformed_features Returns tfma.TRANSFORMED_FEATURES_KEY extract.

Methods

clear

D.clear() -> None. Remove all items from D.

get

Retrieve the corresponding layout by the string key.

When there isn't an exact match, all the existing keys in the layout map will be treated as a regex and map against the input key again. The first match will be returned, based on the key insertion order. Return None if there isn't any match found.

Args
key the string key as the query for the layout.

Returns
Corresponding layout based on the query.

get_attributions

View source

Returns tfma.ATTRIBUTIONS_KEY extract.

get_by_key

View source

Returns item for key possibly filtered by model and/or output names.

get_example_weights

View source

Returns tfma.EXAMPLE_WEIGHTS_KEY extract.

get_features

View source

Returns tfma.FEATURES_KEY extract.

get_inputs

View source

Returns tfma.INPUT_KEY extract.

get_labels

View source

Returns tfma.LABELS_KEY extract.

get_model_and_output_names

View source

Returns a list of model_name-output_name tuples present in extracts.

get_predictions

View source

Returns tfma.PREDICTIONS_KEY extract.

get_transformed_features

View source

Returns tfma.TRANSFORMED_FEATURES_KEY extract.

items

D.items() -> a set-like object providing a view on D's items

keys

D.keys() -> a set-like object providing a view on D's keys

pop

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

popitem

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

set_labels

View source

Sets tfma.LABELS_KEY extract for a given model and output.

set_predictions

View source

Sets tfma.PREDICTIONS_KEY extract for a given model and output.

setdefault

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

update

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values

D.values() -> an object providing a view on D's values