[LLM] IPEX auto importer (#9706)

* IPEX auto importer and get_ipex_version.
* Add BIGDL_IMPORT_IPEX to control auto import, default is false.

python/llm/src/bigdl/llm/__init__.py

@@ -20,4 +20,12 @@
 # only search the first bigdl package and end up finding only one sub-package.
 
 from .convert_model import llm_convert
-from .optimize import optimize_model 
+from .optimize import optimize_model
+import os
+
+# Default is false, set to true to auto importing Intel Extension for PyTorch.
+BIGDL_IMPORT_IPEX = os.getenv("BIGDL_IMPORT_IPEX", 'False').lower() in ('true', '1', 't')
+if BIGDL_IMPORT_IPEX:
+    # Import Intel Extension for PyTorch as ipex if XPU version is installed
+    from .utils.ipex_importer import ipex_importer
+    ipex_importer.import_ipex()

python/llm/src/bigdl/llm/utils/ipex_importer.py

@@ -0,0 +1,71 @@
+#
+# Copyright 2016 The BigDL Authors.
+#
+# 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.
+#
+
+from importlib.metadata import distribution, PackageNotFoundError
+import logging
+
+
+class IPEXImporter:
+    """
+    Auto import Intel Extension for PyTorch as ipex,
+    if bigdl-llm xpu version is installed.
+    """
+    def __init__(self):
+        self.ipex_version = None
+
+    @staticmethod
+    def is_xpu_version_installed():
+        """
+        Check if bigdl-llm xpu version is install
+
+        Returns ture if installed false if not
+        """
+        # Check if xpu version installed
+        try:
+            distribution('bigdl-core-xe')
+            return True
+        except PackageNotFoundError:
+            return False
+
+    def import_ipex(self):
+        """
+        Try to import Intel Extension for PyTorch as ipex
+
+        Raises ImportError if failed
+        """
+        if self.is_xpu_version_installed():
+            import intel_extension_for_pytorch as ipex
+            self.ipex_version = ipex.__version__
+            logging.info("intel_extension_for_pytorch auto imported")
+
+    def get_ipex_version(self):
+        """
+        Get ipex version
+
+        Raises ImportError if cannot import Intel Extension for PyTorch
+        """
+        if self.ipex_version is not None:
+            return self.ipex_version
+        # try to import Intel Extension for PyTorch and get version
+        try:
+            import intel_extension_for_pytorch as ipex
+            self.ipex_version = ipex.__version__
+        except ImportError:
+            self.ipex_version = None
+        return self.ipex_version
+
+
+ipex_importer = IPEXImporter()