official/recommendation/uplift/keys.py

# Copyright 2023 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Defines enum keys used by the keras uplift modeling library."""
import enum


class StrEnum(str, enum.Enum):
  """An Enum represented by a string."""


class TwoTowerPredictionKeys(StrEnum):
  """Keys for prediction tensors."""

  UPLIFT = "uplift_predictions"
  CONTROL = "control_predictions"
  TREATMENT = "treatment_predictions"