Add FutureWarning of UCX < 1.11.1 deprecation (#779)

* Add FutureWarning of UCX < 1.11.1 deprecation * Add deprecation note to UCX 1.9 docs
rapidsai · Nov 22, 2021 · fbd6071 · fbd6071
1 parent 6e0f28f
commit fbd6071
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -93,8 +93,8 @@ Instructions for building UCX 1.11.1:
     make -j install
 
 
-UCX-1.9
-~~~~~~~
+UCX-1.9 (Deprecated)
+~~~~~~~~~~~~~~~~~~~~
 
 Instructions for building ucx 1.9:
 
@@ -133,7 +133,7 @@ As noted above, the UCX conda package no longer builds support for IB/RDMA.  To
 
 If OFED drivers are not installed on the machine, you can download drivers at directly from `Mellanox <https://www.mellanox.com/products/infiniband-drivers/linux/mlnx_ofed>`_.  For versions older than 5.1 click on, *archive versions*.
 
-Building UCX 1.9 or 1.11 as shown previously should automatically include IB/RDMA support if available in the system. It is possible to explicitly activate those, ensuring the system satisfies all dependencies or fail otherwise, by including the ``--with-rdmacm`` and ``--with-verbs`` build flags. For example:
+Building UCX 1.11.1 or 1.9 (deprecated) as shown previously should automatically include IB/RDMA support if available in the system. It is possible to explicitly activate those, ensuring the system satisfies all dependencies or fail otherwise, by including the ``--with-rdmacm`` and ``--with-verbs`` build flags. For example:
 
 ::
 

diff --git a/ucp/__init__.py b/ucp/__init__.py
@@ -5,6 +5,7 @@
 
 import logging
 import os
+import warnings
 
 logger = logging.getLogger("ucx")
 
@@ -41,3 +42,10 @@
 
 __version__ = _get_versions()["version"]
 __ucx_version__ = "%d.%d.%d" % get_ucx_version()
+
+if get_ucx_version() < (1, 11, 1):
+    warnings.warn(
+        f"Support for UCX {__ucx_version__} is deprecated, it's highly recommended "
+        "upgrading to 1.11.1 or newer.",
+        FutureWarning,
+    )