Skip to content

Commit 2f9c91f

Browse files
seanpmorganseanpmorgan
authored
DOC update subpackages (#96)
* DOC: Update subpackages
1 parent 3bf1b5f commit 2f9c91f

File tree

7 files changed

+79
-38
lines changed

7 files changed

+79
-38
lines changed

‎README.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ developments that cannot be integrated into core TensorFlow
2626
used by a smaller subset of the community).
2727

2828
## Maintainers
29-
| Sub-Package | Maintainers | Contact Info |
29+
| Subpackage | Maintainers | Contact Info |
3030
|:----------------------- |:----------- |:----------------------------|
3131
| tfa.activations | SIG-Addons | addons@tensorflow.org |
3232
| tfa.image | | |
@@ -37,19 +37,20 @@ developments that cannot be integrated into core TensorFlow
3737

3838
## Core Concepts
3939

40-
#### Standardized APIs
40+
#### Standardized API within Subpackages
4141
User experience and project maintainability are core concepts in
4242
TF-Addons. In order to achieve these we require that our additions
4343
conform to established API patterns seen in core TensorFlow. Below is
4444
the list we adhere to:
4545

46+
1) [Activations](tensorflow_addons/activations/README.md)
47+
2) [Image](tensorflow_addons/image/README.md)
48+
3) [Layers](tensorflow_addons/layers/README.md)
49+
4) [Losses](tensorflow_addons/losses/README.md)
50+
5) [Optimizers](tensorflow_addons/optimizers/README.md)
51+
6) [Text](tensorflow_addons/text/README.md)
4652

47-
1) [Layers](tensorflow_addons/layers/README.md)
48-
2) [Optimizers](tensorflow_addons/optimizers/README.md)
49-
3) [Losses](tensorflow_addons/losses/README.md)
50-
4) [Custom Ops](tensorflow_addons/custom_ops/README.md)
51-
52-
#### Periodic Evaluation
53+
#### Periodic Evaluation of Subpackages
5354
Based on the nature of this repository, there will be contributions that
5455
in time become dated and unused. In order to keep the project
5556
maintainable, SIG-Addons will perform periodic reviews and deprecate

‎tensorflow_addons/activations/README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Addons - Activations
22

33
## Maintainers
4-
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:------------- |:--------------|
6+
| sparsemax | SIG-Addons | addons@tensorflow.org |
57

68
## Contents
7-
| Layer | Reference |
8-
|:----------------------- |:-----------------------------|
9-
| Sparsemax | https://arxiv.org/abs/1602.02068 |
9+
| Submodule | Activation | Reference |
10+
|:----------------------- |:-------------------|:---------------|
11+
| sparsemax | Sparsemax | https://arxiv.org/abs/1602.02068 |
1012

1113

1214
## Contribution Guidelines

‎tensorflow_addons/image/README.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
11
# Addons - Image
22

33
## Maintainers
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:----------- |:--------------|
6+
| distort_image_ops | | |
7+
| transform_ops | | |
8+
9+
## Components
10+
| Submodule | Image Processing Function | Reference |
11+
|:---------- |:----------- |:----------- |
12+
| distort_image_ops | adjust_hsv_in_yiq | |
13+
| distort_image_ops | random_hsv_in_yiq | |
14+
| transform_ops | transform | |
15+
| transform_ops | angles_to_projective_transforms | |
16+
| transform_ops | atrices_to_flat_transforms | |
417

518
## Contribution Guidelines
619
#### Standard API
7-
In order to conform with the current API standard, all custom ops
20+
In order to conform with the current API standard, all image ops
821
must:
22+
* Be a standard image processing technique
923
* Must be impossible to implement in one of the other API
1024
standards (Layers, Losses, etc.).
1125
* Add the addon to the `py_library` in this sub-package's BUILD file.
1226

1327
#### Testing Requirements
14-
* Simple unittests that demonstrate the custom op is behaving as
28+
* Simple unittests that demonstrate the image op is behaving as
1529
expected.
1630
* When applicable, run all unittests with TensorFlow's
1731
`@run_in_graph_and_eager_modes` (for test method)

‎tensorflow_addons/layers/README.md‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
# Addons - Layers
22

33
## Maintainers
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:----------- |:------------- |
6+
| maxout | SIG-Addons | addons@tensorflow.org |
7+
| normalizations | SIG-Addons | addons@tensorflow.org |
8+
| poincare | SIG-Addons | addons@tensorflow.org |
9+
| sparsemax | SIG-Addons | addons@tensorflow.org |
10+
| wrappers | SIG-Addons | addons@tensorflow.org |
411

5-
## Contents
6-
| Layer | Reference |
7-
|:----------------------- |:-----------------------------|
8-
| GroupNormalization | https://arxiv.org/abs/1803.08494 |
9-
| InstanceNormalization | https://arxiv.org/abs/1607.08022 |
10-
| LayerNormalization | https://arxiv.org/abs/1607.06450 |
11-
| Maxout | https://arxiv.org/abs/1302.4389 |
12-
| PoincareNormalize | https://arxiv.org/abs/1705.08039 |
13-
| WeightNormalization | https://arxiv.org/abs/1602.07868 |
14-
12+
## Components
13+
| Submodule | Layer | Reference |
14+
|:---------- |:----------- |:------------- |
15+
| maxout | Maxout | https://arxiv.org/abs/1302.4389 |
16+
| normalizations | GroupNormalization | https://arxiv.org/abs/1803.08494 |
17+
| normalizations | InstanceNormalization | https://arxiv.org/abs/1607.08022 |
18+
| normalizations | LayerNormalization | https://arxiv.org/abs/1607.06450 |
19+
| poincare | PoincareNormalize | https://arxiv.org/abs/1705.08039 |
20+
| sparsemax| Sparsemax | https://arxiv.org/abs/1602.02068 |
21+
| wrappers | WeightNormalization | https://arxiv.org/abs/1602.07868 |
1522

1623
## Contribution Guidelines
1724
#### Standard API

‎tensorflow_addons/losses/README.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# Addons - Losses
22

33
## Maintainers
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:----------- |:------------- |
6+
| lifted | SIG-Addons | addons@tensorflow.org |
7+
| sparsemax_loss | SIG-Addons | addons@tensorflow.org |
8+
| triplet | SIG-Addons | addons@tensorflow.org |
49

5-
## Contents
6-
| Loss | Reference |
7-
|:----------------------- |:-------------------------------------|
8-
| LiftedStructLoss | https://arxiv.org/abs/1511.06452 |
9-
| SparsemaxLoss | https://arxiv.org/abs/1602.02068 |
10-
| TripletSemiHardLoss | https://arxiv.org/abs/1503.03832 |
10+
## Components
11+
| Submodule | Loss | Reference |
12+
|:----------------------- |:---------------------|:--------------------------|
13+
| lifted | LiftedStructLoss | https://arxiv.org/abs/1511.06452 |
14+
| sparsemax_loss | SparsemaxLoss | https://arxiv.org/abs/1602.02068 |
15+
| triplet | TripletSemiHardLoss | https://arxiv.org/abs/1503.03832 |
1116

1217

1318
## Contribution Guidelines

‎tensorflow_addons/optimizers/README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Addons - Optimizers
22

33
## Maintainers
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:------------- |:--------------|
6+
| lazy_adam_optimizer | SIG-Addons | addons@tensorflow.org |
47

5-
6-
## Contents
7-
| Optimizer | Reference |
8-
|:----------------------- |:-------------------------------|
9-
| LazyAdamOptimizer | https://arxiv.org/abs/1412.6980 |
8+
## Components
9+
| Submodule | Optimizer | Reference |
10+
|:----------------------- |:---------------------- |:---------|
11+
| lazy_adam_optimizer | LazyAdamOptimizer | https://arxiv.org/abs/1412.6980 |
1012

1113

1214
## Contribution Guidelines

‎tensorflow_addons/text/README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# Addons - Text
22

33
## Maintainers
4+
| Submodule | Maintainers | Contact Info |
5+
|:---------- |:----------- |:------------- |
6+
| skip_gram_ops | | |
7+
8+
## Components
9+
| Submodule | Text Processing Function | Reference |
10+
|:---------- |:----------- |:----------- |
11+
| skip_gram_ops | skip_gram_sample | https://arxiv.org/abs/1301.3781 |
12+
| skip_gram_ops | skip_gram_sample_with_text_vocab | https://arxiv.org/abs/1301.3781 |
413

514
## Contribution Guidelines
615
#### Standard API
7-
In order to conform with the current API standard, all custom ops
16+
In order to conform with the current API standard, all text ops
817
must:
9-
* Must be impossible to implement in one of the other API
18+
* Be impossible to implement in one of the other API
1019
standards (Layers, Losses, etc.).
20+
* Be related to text processing.
1121
* Add the addon to the `py_library` in this sub-package's BUILD file.
1222

1323
#### Testing Requirements
14-
* Simple unittests that demonstrate the custom op is behaving as
24+
* Simple unittests that demonstrate the text op is behaving as
1525
expected.
1626
* When applicable, run all unittests with TensorFlow's
1727
`@run_in_graph_and_eager_modes` (for test method)

0 commit comments

Comments
 (0)