From b186d0ee624cc801800b9c25efbcf9d580b396e6 Mon Sep 17 00:00:00 2001 From: Alexey Volkov Date: Mon, 27 Apr 2020 15:54:23 -0700 Subject: [PATCH 1/2] Components - Added readme for TFX components --- components/tfx/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 components/tfx/README.md diff --git a/components/tfx/README.md b/components/tfx/README.md new file mode 100644 index 00000000000..f1475aed5bc --- /dev/null +++ b/components/tfx/README.md @@ -0,0 +1,17 @@ +## TFX components for Kubefow Pipelines + +Disclaimer: The TFX components in this directory are unofficial and are maintained by the KFP team not the TFX team. + +If you experience any issues in this components please create a new issue in the Kubeflow Pipelines repo and assign it to Ark-kun. + +These components were created to allow the users to use TFX components in their KFP pipelines, to be able to mix KFP and TFX components. + +If your pipeline uses only TFX components, please use the official [TFX SDK](https://www.tensorflow.org/tfx/guide). + +See the [sample pipeline](_samples/TFX_pipeline.ipynb) which showcases most of the components. + +Aspects and limitations +* These components use the official TFX container image. +* These components run the executors and component classes of the official TFX components. +* These components do not execute TFX drivers, so they do not log metadata themselves (the metadata is logged by the Metadata Writer service instead). The properties of artifacts are currently not logged. +* These components do not execute TFX launchers, so some features might be limited. For example, it's currently not possible to pass `beam_pipeline_args` which prevents some components from utilizing Google Cloud Dataflow. From b7d416e67d5ab7b3150bd78143a8581eec3d7a9c Mon Sep 17 00:00:00 2001 From: Alexey Volkov Date: Mon, 27 Apr 2020 21:15:48 -0700 Subject: [PATCH 2/2] Resolved review feedback --- components/tfx/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/components/tfx/README.md b/components/tfx/README.md index f1475aed5bc..a4e66bb3425 100644 --- a/components/tfx/README.md +++ b/components/tfx/README.md @@ -1,17 +1,17 @@ -## TFX components for Kubefow Pipelines +## Versions of TFX components that can be used with KFP SDK -Disclaimer: The TFX components in this directory are unofficial and are maintained by the KFP team not the TFX team. +Disclaimer: The components in this directory are unofficial and are maintained by the KFP team not the TFX team. If you experience any issues in this components please create a new issue in the Kubeflow Pipelines repo and assign it to Ark-kun. These components were created to allow the users to use TFX components in their KFP pipelines, to be able to mix KFP and TFX components. -If your pipeline uses only TFX components, please use the official [TFX SDK](https://www.tensorflow.org/tfx/guide). +If your pipeline uses only TFX components, please use the official [TFX SDK](https://www.tensorflow.org/tfx/tutorials/tfx/cloud-ai-platform-pipelines). See the [sample pipeline](_samples/TFX_pipeline.ipynb) which showcases most of the components. Aspects and limitations * These components use the official TFX container image. * These components run the executors and component classes of the official TFX components. -* These components do not execute TFX drivers, so they do not log metadata themselves (the metadata is logged by the Metadata Writer service instead). The properties of artifacts are currently not logged. -* These components do not execute TFX launchers, so some features might be limited. For example, it's currently not possible to pass `beam_pipeline_args` which prevents some components from utilizing Google Cloud Dataflow. +* These components do not execute TFX [drivers](https://www.tensorflow.org/tfx/api_docs/python/tfx/components/base/base_driver), so they do not log metadata themselves (the metadata is logged by the Metadata Writer service instead). The properties of artifacts are currently not logged. +* These components do not execute TFX launchers, so some features might be limited. For example, it's currently not possible to pass `beam_pipeline_args` which prevents some components from utilizing Google Cloud Dataflow.