tfma.metrics.PlotKey
Stay organized with collections
Save and categorize content based on your preferences.
A PlotKey is a metric key that uniquely identifies a plot.
Inherits From: MetricKey
tfma.metrics.PlotKey(
name: str,
model_name: str = '',
output_name: str = '',
sub_key: Optional[tfma.metrics.SubKey] = None,
aggregation_type: Optional[AggregationType] = None,
example_weighted: Optional[bool] = False,
is_diff: Optional[bool] = False
)
Attributes |
|---|
name
|
A namedtuple alias for field number 0
|
model_name
|
A namedtuple alias for field number 1
|
output_name
|
A namedtuple alias for field number 2
|
sub_key
|
A namedtuple alias for field number 3
|
aggregation_type
|
A namedtuple alias for field number 4
|
example_weighted
|
A namedtuple alias for field number 5
|
is_diff
|
A namedtuple alias for field number 6
|
Methods
from_proto
View source
@staticmethod
from_proto(
pb: metrics_for_slice_pb2.PlotKey
) -> 'PlotKey'
Configures class from proto.
make_baseline_key
View source
make_baseline_key(
model_name: str
) -> 'MetricKey'
make_diff_key
View source
make_diff_key() -> 'MetricKey'
to_proto
View source
to_proto() -> metrics_for_slice_pb2.PlotKey
Converts key to proto.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-04-26 UTC."],[],[],null,["# tfma.metrics.PlotKey\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L377-L407) |\n\nA PlotKey is a metric key that uniquely identifies a plot.\n\nInherits From: [`MetricKey`](../../tfma/metrics/MetricKey) \n\n tfma.metrics.PlotKey(\n name: str,\n model_name: str = '',\n output_name: str = '',\n sub_key: Optional[../../tfma/metrics/SubKey] = None,\n aggregation_type: Optional[AggregationType] = None,\n example_weighted: Optional[bool] = False,\n is_diff: Optional[bool] = False\n )\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Attributes ---------- ||\n|--------------------|-----------------------------------------|\n| `name` | A `namedtuple` alias for field number 0 |\n| `model_name` | A `namedtuple` alias for field number 1 |\n| `output_name` | A `namedtuple` alias for field number 2 |\n| `sub_key` | A `namedtuple` alias for field number 3 |\n| `aggregation_type` | A `namedtuple` alias for field number 4 |\n| `example_weighted` | A `namedtuple` alias for field number 5 |\n| `is_diff` | A `namedtuple` alias for field number 6 |\n\n\u003cbr /\u003e\n\nMethods\n-------\n\n### `from_proto`\n\n[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L395-L407) \n\n @staticmethod\n from_proto(\n pb: metrics_for_slice_pb2.PlotKey\n ) -\u003e 'PlotKey'\n\nConfigures class from proto.\n\n### `make_baseline_key`\n\n[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L365-L366) \n\n make_baseline_key(\n model_name: str\n ) -\u003e 'MetricKey'\n\n### `make_diff_key`\n\n[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L361-L362) \n\n make_diff_key() -\u003e 'MetricKey'\n\n### `to_proto`\n\n[View source](https://github.com/tensorflow/model-analysis/blob/v0.46.0/tensorflow_model_analysis/metrics/metric_types.py#L380-L393) \n\n to_proto() -\u003e metrics_for_slice_pb2.PlotKey\n\nConverts key to proto."]]
View source on GitHub