ENH: Restructure custom ops (#49)

* ENH: Restructure custom ops

Author: seanpmorgan

BUILD

@@ -6,10 +6,9 @@ sh_binary(
         "MANIFEST.in",
         "setup.py",
         "tensorflow_addons/__init__.py",
-        "//tensorflow_addons/image:images_ops_py",
+        "//tensorflow_addons/custom_ops:custom_ops_py",
         "//tensorflow_addons/layers:layers_py",
         "//tensorflow_addons/losses:losses_py",
         "//tensorflow_addons/optimizers:optimizers_py",
-        "//tensorflow_addons/text:text_py",
     ],
 )

CONTRIBUTING.md

@@ -40,7 +40,7 @@ fitting the following criteria:
     * [Layers](tensorflow_addons/layers/README.md) |
       [Optimizers](tensorflow_addons/optimizers/README.md) |
       [Losses](tensorflow_addons/losses/README.md) |
-      Custom Ops
+      [Custom Ops](tensorflow_addons/custom_ops/README.md)
 
 **Note: New contributions often require team-members to read a research
 paper and understand how it fits into the TensorFlow community. This

README.md

@@ -32,7 +32,7 @@ the list we adhere to:
 1) [Layers](tensorflow_addons/layers/README.md)
 1) [Optimizers](tensorflow_addons/optimizers/README.md)
 1) [Losses](tensorflow_addons/losses/README.md)
-1) Custom Ops
+1) [Custom Ops](tensorflow_addons/custom_ops/README.md)
 
 #### Periodic Evaluation
 Based on the nature of this repository, there will be contributions that
@@ -58,11 +58,11 @@ https://bazel.build/) build system.
 git clone https://github.com/tensorflow/addons.git
 cd addons
 
-# This script tells bazel where the tensorflow dependency can be found
-./configure.sh  # Links project with TensorFlow dependency
+# This script links project with TensorFlow dependency
+./configure.sh
 
 bazel build build_pip_pkg
-bazel-bin/build_pip_pkg artifact
+bazel-bin/build_pip_pkg artifacts
 
 pip install artifacts/tensorflow_addons-*.whl
 ```

tensorflow_addons/custom_ops/BUILD

@@ -0,0 +1,13 @@
+licenses(["notice"])  # Apache 2.0
+
+package(default_visibility = ["//visibility:public"])
+
+py_library(
+    name = "custom_ops_py",
+    srcs = ["__init__.py"],
+    srcs_version = "PY2AND3",
+    deps = [
+            "//tensorflow_addons/custom_ops/image:images_ops_py",
+            "//tensorflow_addons/custom_ops/text:text_py",
+        ]
+)

tensorflow_addons/custom_ops/README.md

@@ -0,0 +1,22 @@
+# Addons - Custom Ops
+
+## Contents
+| Layer  | Description                             |
+|:----------------------- |:-----------------------------|
+| Image | Ops for image manipulation   |
+| Text |  Ops for text processing  |
+
+
+
+## Contribution Guidelines
+#### Standard API
+In order to conform with the current API standard, all custom ops
+must:
+ * Must be impossible to implement in one of the other API
+ standards (Layers, Losses, etc.)
+
+#### Testing Requirements
+ * Simple unittests that demonstrate the custom op is behaving as
+    expected.
+ * When applicable, run all unittests with TensorFlow's
+  `@run_all_in_graph_and_eager_modes` decorator.

tensorflow_addons/image/python/__init__.py renamed to tensorflow_addons/custom_ops/__init__.py

@@ -0,0 +1 @@
+# Custom Op - Image

tensorflow_addons/image/BUILD renamed to tensorflow_addons/custom_ops/image/BUILD

@@ -12,13 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""
-Text-processing ops.
-"""
+"""Image manipulation ops"""
 from __future__ import absolute_import
 from __future__ import division
 from __future__ import print_function
 
-# Skip Gram Sample
-from tensorflow_addons.text.python.skip_gram_ops import skip_gram_sample
-from tensorflow_addons.text.python.skip_gram_ops import skip_gram_sample_with_text_vocab
+# Transforms
+from tensorflow_addons.custom_ops.image.python.transform import transform

tensorflow_addons/custom_ops/image/README.md

@@ -1,4 +1,4 @@
-/* Copyright 2016 The TensorFlow Authors. All Rights Reserved.
+/* Copyright 2019 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.
@@ -19,11 +19,11 @@ limitations under the License.
 #define EIGEN_USE_GPU
 #endif  // GOOGLE_CUDA
 
-#include "tensorflow_addons/image/cc/kernels/image_projective_transform_op.h"
 #include "tensorflow/core/framework/op_kernel.h"
 #include "tensorflow/core/framework/register_types.h"
 #include "tensorflow/core/framework/types.h"
 #include "tensorflow/core/platform/types.h"
+#include "tensorflow_addons/custom_ops/image/cc/kernels/image_projective_transform_op.h"
 
 namespace tensorflow {