Add a warning when trying to load a custom op with a uncompatible version of TF.

tensorflow_addons/utils/resource_loader.py

@@ -14,10 +14,16 @@
 # ==============================================================================
 """Utilities similar to tf.python.platform.resource_loader."""
 
+from distutils.version import LooseVersion
 import os
+import warnings
 
 import tensorflow as tf
 
+MIN_TF_VERSION_FOR_ABI_COMPATIBILITY = "2.1.0"
+MAX_TF_VERSION_FOR_ABI_COMPATIBILITY = "2.2.0"
+abi_warning_already_raised = False
+
 
 def get_project_root():
     """Returns project root folder."""
@@ -46,5 +52,56 @@ def __init__(self, relative_path):
     @property
     def ops(self):
         if self._ops is None:
+            self.display_warning_if_incompatible()
             self._ops = tf.load_op_library(get_path_to_datafile(self.relative_path))
         return self._ops
+
+    def display_warning_if_incompatible(self):
+        global abi_warning_already_raised
+        if abi_is_compatible() or abi_warning_already_raised:
+            return
+
+        warnings.warn(
+            "You are currently using TensorFlow {} and trying to load a custom op ({})."
+            "\n"
+            "TensorFlow Addons has compiled its custom ops against TensorFlow {}, "
+            "and there are no compatibility guarantees between the two versions. "
+            "\n"
+            "This means that you might get segfaults when loading the custom op, "
+            "or other kind of low-level errors.\n If you do, do not file an issue "
+            "on Github. This is a known limitation."
+            "\n\n"
+            "It might help you to fallback to pure Python "
+            "ops with TF_ADDONS_PY_OPS . To do that, see "
+            "https://github.com/tensorflow/addons#gpucpu-custom-ops "
+            "\n\n"
+            "You can also change the TensorFlow version installed on your system. "
+            "You would need a TensorFlow version equal to or above {} and strictly "
+            "below {}.\n Note that nightly versions of TensorFlow, "
+            "as well as non-pip TensorFlow like `conda install tensorflow` or compiled "
+            "from source are not supported."
+            "\n\n"
+            "The last solution is to find the TensorFlow Addons version that has "
+            "custom ops compatible with the TensorFlow installed on your "
+            "system. To do that, refer to the readme: "
+            "https://github.com/tensorflow/addons"
+            "".format(
+                tf.__version__,
+                self.relative_path,
+                MIN_TF_VERSION_FOR_ABI_COMPATIBILITY,
+                MIN_TF_VERSION_FOR_ABI_COMPATIBILITY,
+                MAX_TF_VERSION_FOR_ABI_COMPATIBILITY,
+            ),
+            UserWarning,
+        )
+        abi_warning_already_raised = True
+
+
+def abi_is_compatible():
+    if "dev" in tf.__version__:
+        # tf-nightly
+        return False
+
+    min_version = LooseVersion(MIN_TF_VERSION_FOR_ABI_COMPATIBILITY)
+    max_version = LooseVersion(MAX_TF_VERSION_FOR_ABI_COMPATIBILITY)
+    return min_version <= LooseVersion(tf.__version__) < max_version