Optionally import ModelCardGenerator

Author: codesue

README.md

@@ -37,11 +37,19 @@ The Model Card Toolkit is hosted on [PyPI](https://pypi.org/project/model-card-t
 
 If you are using [TensorFlow Extended (TFX)](https://www.tensorflow.org/tfx), you can
 incorporate model card generation into your TFX pipeline via the `ModelCardGenerator`
-component. The `ModelCardGenerator` component is moving to the
-[TFX Addons](https://github.com/tensorflow/tfx-addons) library and will not be
-included in Model Card Toolkit from version 1.4.0. This page will be updated to
-include the new links for the Model Cards in TFX
-guide and the end-to-end demo when that migration is completed.
+component.
+
+The `ModelCardGenerator` component is moving to the
+[TFX Addons](https://github.com/tensorflow/tfx-addons) library and will no longer
+be packaged in Model Card Toolkit from version 1.4.0. Before you can use the
+component, you will need to install the `tfx-addons` package:
+
+```sh
+pip install tfx-addons[model_card_generator]
+```
+
+This page will be updated to include the new links for the Model Cards in TFX
+guide and the end-to-end demo when the migration is completed.
 
 ## Schema
 

model_card_toolkit/__init__.py

@@ -14,5 +14,6 @@
 """A module to streamline and automate generation of Model Cards."""
 from model_card_toolkit.core import ModelCardToolkit
 from model_card_toolkit.model_card import *
+from model_card_toolkit.tfx.component import ModelCardGenerator
 from model_card_toolkit.utils.source import *
 from model_card_toolkit.version import __version__

model_card_toolkit/tfx/__init__.py

@@ -1,23 +1,14 @@
-"""
-Removal notice for the ModelCardGenerator TFX component.
-"""
-
-raise ImportError(
-    """
-    The ModelCardGenerator component and its dependencies have been moved to
-    the TFX Addons project (https://github.com/tensorflow/tfx-addons).
-
-    Install the tfx-addons package with
-
-    ```
-    $ pip install tfx-addons[model_card_generator]
-    ```
-
-    You can then import the component via
-    ```
-    from tfx_addons.model_card_generator.component import ModelCardGenerator
-    ```
-
-    and use it as usual.
-    """
-)
+# 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.
+# ==============================================================================

model_card_toolkit/tfx/component.py

@@ -0,0 +1,35 @@
+# 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.
+# ==============================================================================
+"""
+Optionally imports the ModelCardGenerator TFX component.
+"""
+import logging
+
+try:
+  from tfx_addons.model_card_generator.component import ModelCardGenerator
+except ImportError:
+  ModelCardGenerator = None
+  logging.info(
+      """
+      The ModelCardGenerator component and its dependencies have been moved to
+      the TFX Addons project (https://github.com/tensorflow/tfx-addons).
+
+      If you'd like to use the component, you need to install the tfx-addons package:
+
+      ```
+      $ pip install tfx-addons[model_card_generator]
+      ```
+      """
+  )