Internal change

PiperOrigin-RevId: 408278219

Author: achoum

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.1 - 2021-11-05
+
+### Features
+
+-   Compatibility with TensorFlow 2.7.0.
+
 ## 0.2.0 - 2021-10-29
 
 ### Features

WORKSPACE

@@ -9,13 +9,9 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 http_archive(
     name = "org_tensorflow",
 
-    # sha256 = "4896b49c4088030f62b98264441475c09569ea6e49cfb270e2e1f3ef0f743a2f",
-    # strip_prefix = "tensorflow-2.7.0-rc1",
-    # urls = ["https://github.com/tensorflow/tensorflow/archive/refs/tags/v2.7.0-rc1.zip"],
-
-    sha256 = "40d3203ab5f246d83bae328288a24209a2b85794f1b3e2cd0329458d8e7c1985",
-    strip_prefix = "tensorflow-2.6.0",
-    urls = ["https://github.com/tensorflow/tensorflow/archive/refs/tags/v2.6.0.zip"],
+    sha256 = "249b48ddee927801c7a4f8e5442cf1a3c860f6f46b85a2ff7a78b501507dd561",
+    strip_prefix = "tensorflow-2.7.0",
+    urls = ["https://github.com/tensorflow/tensorflow/archive/refs/tags/v2.7.0.zip"],
 
     #urls = ["https://github.com/tensorflow/tensorflow/archive/master.zip"],
     #strip_prefix = "tensorflow-master",

configure/setup.py

@@ -20,15 +20,15 @@
 from setuptools.command.install import install
 from setuptools.dist import Distribution
 
-_VERSION = "0.2.0"
+_VERSION = "0.2.1"
 
 with open("README.md", "r", encoding="utf-8") as fh:
   long_description = fh.read()
 
 REQUIRED_PACKAGES = [
     "numpy",
     "pandas",
-    "tensorflow~=2.6",  # "tensorflow >= 2.7.0rc0, < 2.8'",
+    "tensorflow~=2.7.0",
     "six",
     "absl_py",
     "wheel",

documentation/known_issues.md

@@ -47,6 +47,7 @@ The following table shows the compatibility between
 
 tensorflow_decision_forests | tensorflow
 --------------------------- | ----------
+0.2.1                       | 2.7
 0.2.0                       | 2.6
 0.1.9                       | 2.6
 0.1.1 - 0.1.8               | 2.5

tensorflow_decision_forests/BUILD

@@ -16,6 +16,7 @@ py_library(
         "//tensorflow_decision_forests/component/model_plotter",
         "//tensorflow_decision_forests/component/py_tree",
         "//tensorflow_decision_forests/keras",
+        "//tensorflow_decision_forests/tensorflow:check_version",
     ],
 )
 

tensorflow_decision_forests/__init__.py

@@ -45,9 +45,15 @@
 
 """
 
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 __author__ = "Mathieu Guillame-Bert"
 
+compatible_tf_versions = ["2.7.0"]
+
+from tensorflow_decision_forests.tensorflow import check_version
+
+check_version.check_version(__version__, compatible_tf_versions)
+
 from tensorflow_decision_forests import keras
 from tensorflow_decision_forests.component import py_tree
 from tensorflow_decision_forests.component.builder import builder

tensorflow_decision_forests/tensorflow/BUILD

@@ -89,6 +89,13 @@ py_library(
     }),
 )
 
+py_library(
+    name = "check_version",
+    srcs = ["check_version.py"],
+    srcs_version = "PY3",
+    deps = ["@org_tensorflow//tensorflow/python"],
+)
+
 # Tests
 # =====
 
@@ -104,3 +111,13 @@ py_test(
         "@ydf//yggdrasil_decision_forests/learner:abstract_learner_py_proto",
     ],
 )
+
+py_test(
+    name = "check_version_test",
+    srcs = ["check_version_test.py"],
+    python_version = "PY3",
+    deps = [
+        ":check_version",
+        "@org_tensorflow//tensorflow/python",
+    ],
+)

tensorflow_decision_forests/tensorflow/check_version.py

@@ -0,0 +1,50 @@
+# Copyright 2021 Google LLC.
+#
+# 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
+#
+#     https://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.
+
+"""Check that version of TensorFlow is compatible with TF-DF."""
+
+import logging
+import tensorflow as tf
+
+
+def check_version(tf_df_version,
+                  compatible_tf_versions,
+                  tf_version=None,
+                  external_logic=False):
+  """Checks the compatibility of the TF version.
+
+  Prints a warning message and return False in care of likely incompatible
+  versions.
+  """
+
+  if not external_logic:
+
+  if tf_version is None:
+    tf_version = tf.__version__
+  if tf_version not in compatible_tf_versions:
+    logging.warning(
+        "TensorFlow Decision Forests %s is compatible with the following "
+        "TensorFlow Versions: %s. However, TensorFlow %s was detected. "
+        "This can cause issues with the TF API and symbols in the custom C++ "
+        "ops. See the TF and TF-DF compatibility table at "
+        "https://github.com/tensorflow/decision-forests/blob/main/documentation/known_issues.md#compatibility-table.",
+        tf_df_version, compatible_tf_versions, tf_version)
+    return False
+  return True
+
+
+def info_fail_to_load_custom_op(exception):
+  logging.warning("Failure to load the custom c++ tensorflow ops. "
+                  "This error is likely caused the version of TensorFlow and "
+                  "TensorFlow Decision Forests are not compatible.")

tensorflow_decision_forests/tensorflow/check_version_test.py

@@ -0,0 +1,40 @@
+# Copyright 2021 Google LLC.
+#
+# 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
+#
+#     https://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.
+
+import tensorflow as tf
+
+from tensorflow_decision_forests.tensorflow import check_version
+
+
+class CheckVersionTest(tf.test.TestCase):
+
+  def test_base(self):
+
+    tf_df_version = "1.2.3"  # Does not matter.
+    self.assertTrue(
+        check_version.check_version(
+            tf_df_version, ["2.6.0", "2.6.1"], "2.6.0", external_logic=True))
+    self.assertFalse(
+        check_version.check_version(
+            tf_df_version, ["2.6.0", "2.6.1"],
+            "2.8.0-dev20211105",
+            external_logic=True))
+    self.assertFalse(
+        check_version.check_version(
+            tf_df_version, ["2.6.0", "2.6.1"], "2.7.0-rc1",
+            external_logic=True))
+
+
+if __name__ == "__main__":
+  tf.test.main()

tensorflow_decision_forests/tensorflow/distribute/BUILD

@@ -20,6 +20,7 @@ py_library(
     srcs_version = "PY3",
     deps = [
         "@org_tensorflow//tensorflow:tensorflow_py",
+        "//tensorflow_decision_forests/tensorflow:check_version",
     ],
 )