Add deprecation note in README (#216)

Add deprecation note in README.
databricks · Dec 25, 2019 · e2d8023 · e2d8023
1 parent 07bde63
commit e2d8023
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,14 @@ The library is in its early days, and we welcome everyone's feedback and contrib
 
 Maintainers: Bago Amirbekian, Joseph Bradley, Yogesh Garg, Sue Ann Hong, Tim Hunter, Siddharth Murching, Tomas Nykodym, Lu Wang
 
+## Deprecation
+
+The following submodules are deprecated and will be removed in the next release of sparkdl. Please use Pandas UDF instead.
+* `sparkdl.graph`
+* `sparkdl.transformers`
+* `sparkdl.udf`
+
+The class `sparkdl.KerasImageFileEstimator` is deprecated and will be removed in the next release of sparkdl. To replace a KerasImageFileEstimator workflow, please use Distributed Hyperopt with SparkTrials to distribute model tuning.
 
 ## Building and running unit tests