/* Copyright 2022 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.
==============================================================================*/

#ifndef TENSORFLOW_CORE_CONFIG_FLAG_DEFS_H_
#define TENSORFLOW_CORE_CONFIG_FLAG_DEFS_H_

#include "tensorflow/core/config/flags.h"

namespace tensorflow {
namespace flags {

class Flags {
 public:
  // Test only flags. See flags_test.cc for example usage.
  TF_DECLARE_FLAG(test_only_experiment_1, true, "Test only experiment 1.");
  TF_DECLARE_FLAG(test_only_experiment_2, false, "Test only experiment 2.");

  // Declare flags below here.
  // LINT.IfChange
  TF_DECLARE_FLAG(enable_nested_function_shape_inference, false,
                  "Allow ops such as tf.cond to invoke the ShapeRefiner on "
                  "their nested functions.");
  TF_DECLARE_FLAG(enable_quantized_dtypes_training, false,
                  "Set quantized dtypes, like tf.qint8, to be trainable.");
  TF_DECLARE_FLAG(graph_building_optimization, false,
                  "Optimize graph building for faster tf.function tracing.");
  TF_DECLARE_FLAG(
      op_building_optimization, true,
      "Optimize tf.Operation building for faster tf.function tracing.");
  TF_DECLARE_FLAG(saved_model_fingerprinting, true,
                  "Add fingerprint to SavedModels.");
  TF_DECLARE_FLAG(
      tf_shape_default_int64, false,
      "The default output of tf.shape (i.e. when out_type is not specified) is "
      "int64 when this flag is true and int32 otherwise. Setting this to true "
      "is an unsupported, experimental setting that causes known breakages.");
  TF_DECLARE_FLAG(more_stack_traces, false,
                  "Enable experimental code that preserves and propagates "
                  "graph node stack traces in C++.");
  TF_DECLARE_FLAG(publish_function_graphs, true,
                  "Enables the publication of partitioned function graphs "
                  "via StatsPublisherInterface. Disabling this flag can "
                  "reduce memory consumption.");
  TF_DECLARE_FLAG(enable_aggressive_constant_replication, true,
                  "Replicate constants across CPU devices and even for local "
                  "CPUs within the same task if available.")
  TF_DECLARE_FLAG(enable_colocation_key_propagation_in_while_op_lowering, false,
                  "If true, colocation key attributes for the ops will be "
                  "propagated during while op lowering to switch/merge ops.")
  TF_DECLARE_FLAG(enable_tf2min_ici_weight, false,
                  "If true, ici weight optimization will be used in tf2/min.")
  // TODO(b/341325107): Make this behavior the default and remove the flag.
  TF_DECLARE_FLAG(enable_function_pruning_before_inlining, false,
                  "If true, functions will be pruned before inlining.")
  TF_DECLARE_FLAG(enable_skip_encapsulation_for_non_tpu_graphs, false,
                  "If true, TF2XLA encapsulation will be skipped for non-TPU "
                  "graphs.")
  TF_DECLARE_FLAG(enable_graph_debug_info_caching_for_stack_frames, true,
                  "If true, graph debug info will cache the stack frames.")
  TF_DECLARE_FLAG(
      enable_fatal_error_on_collective_abort, false,
      "If true, a fatal error will be raised when a collective is aborted.")
  // LINT.ThenChange(//tensorflow/core/config/flags_api_wrapper.cc)
};

Flags& Global();

}  // namespace flags
}  // namespace tensorflow

#endif  // TENSORFLOW_CORE_CONFIG_FLAG_DEFS_H_
