Home | History | Annotate | Download | only in canned
      1 # Copyright 2017 The TensorFlow Authors. All Rights Reserved.
      2 #
      3 # Licensed under the Apache License, Version 2.0 (the "License");
      4 # you may not use this file except in compliance with the License.
      5 # You may obtain a copy of the License at
      6 #
      7 #     http://www.apache.org/licenses/LICENSE-2.0
      8 #
      9 # Unless required by applicable law or agreed to in writing, software
     10 # distributed under the License is distributed on an "AS IS" BASIS,
     11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 # See the License for the specific language governing permissions and
     13 # limitations under the License.
     14 # ==============================================================================
     15 """Enum for model prediction keys."""
     16 
     17 from __future__ import absolute_import
     18 from __future__ import division
     19 from __future__ import print_function
     20 
     21 from tensorflow.python.estimator import model_fn
     22 
     23 
     24 class MetricKeys(object):
     25   """Metric key strings."""
     26   LOSS = model_fn.LOSS_METRIC_KEY
     27   LOSS_MEAN = model_fn.AVERAGE_LOSS_METRIC_KEY
     28   LOSS_REGULARIZATION = 'regularization_loss'
     29 
     30   ACCURACY = 'accuracy'
     31   # This is the best the model could do by always predicting one class.
     32   # Should be < ACCURACY in a trained model.
     33   ACCURACY_BASELINE = 'accuracy_baseline'
     34   AUC = 'auc'
     35   AUC_PR = 'auc_precision_recall'
     36   LABEL_MEAN = 'label/mean'
     37   PREDICTION_MEAN = 'prediction/mean'
     38 
     39   # The following require a threshold applied, should be float in range (0, 1).
     40   ACCURACY_AT_THRESHOLD = 'accuracy/positive_threshold_%g'
     41   PRECISION_AT_THRESHOLD = 'precision/positive_threshold_%g'
     42   RECALL_AT_THRESHOLD = 'recall/positive_threshold_%g'
     43