ENH: Add documentation guidelines (#51)

Author: seanpmorgan

README.md

@@ -16,7 +16,8 @@ developments that cannot be integrated into core TensorFlow
 | addons.layers | Maxout | https://arxiv.org/abs/1302.4389             |
 | addons.layers | PoinareNormalize | https://arxiv.org/abs/1705.08039  |
 | addons.layers | WeightNormalization | https://arxiv.org/abs/1602.07868 |
-| addons.losses | TripletLoss | https://arxiv.org/abs/1503.03832       |
+| addons.losses | LiftedStructLoss | https://arxiv.org/abs/1511.06452       |
+| addons.losses | TripletSemiHardLoss | https://arxiv.org/abs/1503.03832       |
 | addons.optimizers | LazyAdamOptimizer | https://arxiv.org/abs/1412.6980 |
 | addons.text | SkipGrams | https://arxiv.org/abs/1301.3781 |
 

tensorflow_addons/custom_ops/README.md

@@ -20,3 +20,8 @@ must:
     expected.
  * When applicable, run all unittests with TensorFlow's
   `@run_all_in_graph_and_eager_modes` decorator.
+
+#### Documentation Requirements
+ * Update the table of contents in the project's central README
+ * Update the table of contents in this sub-project's README
+ 

tensorflow_addons/layers/README.md

@@ -22,3 +22,7 @@ must:
   `@run_all_in_graph_and_eager_modes` decorator.
  * Run `keras.testing_utils.layer_test` on the layer.
 
+#### Documentation Requirements
+ * Update the table of contents in the project's central README
+ * Update the table of contents in this sub-project's README
+ 

tensorflow_addons/losses/README.md

@@ -3,7 +3,8 @@
 ## Contents
 | Loss  | Reference                                              |
 |:----------------------- |:-------------------------------------|
-| TripletLoss | https://arxiv.org/abs/1503.03832 |
+| LiftedStructLoss | https://arxiv.org/abs/1511.06452       |
+| TripletSemiHardLoss | https://arxiv.org/abs/1503.03832       |
 
 
 ## Contribution Guidelines
@@ -18,4 +19,9 @@ must:
  * Simple unittests that demonstrate the loss is behaving as expected on
  some set of known inputs and outputs.
  * When applicable, run all tests with TensorFlow's
- `@run_all_in_graph_and_eager_modes` decorator.
+ `@run_all_in_graph_and_eager_modes` decorator.
+ 
+#### Documentation Requirements
+ * Update the table of contents in the project's central README
+ * Update the table of contents in this sub-project's README
+ 

tensorflow_addons/optimizers/README.md

@@ -16,4 +16,9 @@ must:
 
 #### Testing Requirements
  * When applicable, run all tests with TensorFlow's
- `@run_all_in_graph_and_eager_modes` decorator
+ `@run_all_in_graph_and_eager_modes` decorator
+  
+#### Documentation Requirements
+ * Update the table of contents in the project's central README
+ * Update the table of contents in this sub-project's README
+