From 9be6db597c256023331e2e790b861fc2e2f0edb7 Mon Sep 17 00:00:00 2001 From: Nirzari gupta Date: Fri, 2 Jul 2021 21:56:03 +0530 Subject: [PATCH] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d170fe8..243a109 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ This is a TFX-component that allows its users to apply a user code to a schema produced by the [SchemaGen](https://www.tensorflow.org/tfx/guide/schemagen) component, and curate it based on domain knowledge. It fits seamlessly into the ML-pipline made with TFX, and allows schema manipulation based on a module file provided by the User. +## Usage +### Examples demonstrating how to use Schema curation component + +To run locally: [taxi_example_local.py](https://github.com/rcrowe-google/schemacomponent/blob/main/example/taxi_example_local.py) +TO run in colab: [taxi_example_colab.ipynb](https://github.com/rcrowe-google/schemacomponent/blob/main/example/taxi_example_colab.ipynb) + ## Documentation ### Inputs: