Skip to content

Commit 842cf9b

Browse files
Update documentation regarding compatibility (#1562)
* Update documentation regarding compatibility * Update README.md Co-Authored-By: Gabriel de Marmiesse <[email protected]> * Update README.md Co-Authored-By: Gabriel de Marmiesse <[email protected]> * Split compatibility matrix Co-authored-by: Gabriel de Marmiesse <[email protected]>
1 parent 679333c commit 842cf9b

File tree

1 file changed

+40
-9
lines changed

1 file changed

+40
-9
lines changed

Diff for: README.md

+40-9
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,43 @@ import tensorflow as tf
6363
import tensorflow_addons as tfa
6464
```
6565

66-
#### Linux Build Matrix
67-
| Version | Compatible With |Python versions | Compiler | cuDNN | CUDA |
68-
|:----------------------- |:---|:---------- |:---------|:---------|:---------|
69-
| tfa-nightly | tensorflow==2.1.0 | 3.5-3.7 | GCC 7.3.1 | 7.6 | 10.1 |
70-
| tensorflow-addons-0.8.2 | tensorflow==2.1.0 |3.5-3.7 | GCC 7.3.1 | 7.6 | 10.1 |
71-
| tensorflow-addons-0.7.1 | tensorflow==2.1.0 | 2.7, 3.5-3.7 | GCC 7.3.1 | 7.6 | 10.1 |
72-
| tensorflow-addons-0.6.0 | tensorflow==2.0.0 | 2.7, 3.5-3.7 | GCC 7.3.1 | 7.4 | 10.0 |
66+
### Python Op Compatility
67+
TensorFlow Addons is actively working towards forward compatiblity with TF2.x.
68+
However there are still a few private API uses within the respository so at the moment
69+
we can only gurentee compatibility with the versions of TF which it was tested against.
70+
Warnings will be emitted during TFA import if your TensorFlow version does not match
71+
what it was tested against.
72+
73+
#### Python-Op Compatibility Matrix
74+
| TFA Version | TensorFlow | Python |
75+
|:----------------------- |:---|:---------- |
76+
| tfa-nightly | 2.1, 2.2 | 3.5, 3.6, 3.7 |
77+
| tensorflow-addons-0.8.3 | 2.1 |3.5, 3.6, 3.7 |
78+
| tensorflow-addons-0.7.1 | 2.1 | 2.7, 3.5, 3.6, 3.7 |
79+
| tensorflow-addons-0.6.0 | 2.0 | 2.7, 3.5, 3.6, 3.7 |
80+
81+
### C++ Custom Op Compatibility
82+
TensorFlow C++ APIs are not stable and thus we can only guarentee compatibility with the
83+
version TFA was built against. It is possible custom-ops will work with multiple
84+
versions of TF, but there is also a chance for segfault or other problematic crash.
85+
Warnings will be emitted when loading a custom op if your TensorFlow version does not match
86+
what it was built against.
87+
88+
Additionally, registering custom-ops does not have an ABI stable interface so it is
89+
required that users have a compatible installation of TensorFlow even if the versions
90+
match what we had build against. A simplification of this is that **TensorFlow Addons
91+
custom-ops will work with pip installed TensorFlow** but will have issues with TF
92+
compiled differently. A typical reason for this would be conda installed TensorFlow.
93+
[RFC #133](https://github.com/tensorflow/community/pull/133) aims to fix this.
94+
95+
96+
#### Custom-Op Compatibility Matrix
97+
| TFA Version | TensorFlow | Compiler | cuDNN | CUDA |
98+
|:----------------------- |:---- |:---------|:---------|:---------|
99+
| tfa-nightly | 2.1 | GCC 7.3.1 | 7.6 | 10.1 |
100+
| tensorflow-addons-0.8.3 | 2.1 | GCC 7.3.1 | 7.6 | 10.1 |
101+
| tensorflow-addons-0.7.1 | 2.1 | GCC 7.3.1 | 7.6 | 10.1 |
102+
| tensorflow-addons-0.6.0 | 2.0 | GCC 7.3.1 | 7.4 | 10.0 |
73103

74104

75105
#### Nightly Builds
@@ -113,8 +143,9 @@ TF-Addons. In order to achieve these we require that our additions
113143
conform to established API patterns seen in core TensorFlow.
114144

115145
#### GPU/CPU Custom-Ops
116-
A major benefit of TensorFlow Addons is that there are precompiled ops for CPU/GPU.
117-
Currently however, GPU custom ops only work for Linux distributions. For this reason Windows and MacOS will fallback to pure TensorFlow Python implementations whenever possible.
146+
TensorFlow Addons supports precompiled custom ops for CPU/GPU. Currently however,
147+
GPU custom ops only work for Linux distributions. For this reason Windows and MacOS
148+
will fallback to pure TensorFlow Python implementations whenever possible.
118149

119150
The order of priority in MacOS/Windows:
120151
1) Pure TensorFlow + Python implementation (work on cpu+gpu)

0 commit comments

Comments
 (0)