Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added extra requirements for tensorflow, tensorflow-gpu, and tensorflow-cpu #2114

Merged
merged 4 commits into from
Sep 2, 2020
Merged

Added extra requirements for tensorflow, tensorflow-gpu, and tensorflow-cpu #2114

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e40e876
Added extra requirements for tensorflow, tensorflow-gpu, and tensorfl…
tgaddair Aug 24, 2020
45ebb6f
Updated README
tgaddair Aug 24, 2020
711e464
Updated README
tgaddair Aug 27, 2020
3b91af7
Use Python 3.5 compatible syntax
tgaddair Sep 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated README
  • Loading branch information
@tgaddair
tgaddair committed Sep 1, 2020
commit 45ebb6f0e5977c8a0f46de3178d1e5a2626c64e2
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,15 @@ we can only guarantee compatibility with the TensorFlow versions which it was te
Warnings will be emitted when importing `tensorflow_addons` if your TensorFlow version does not match
what it was tested against.

To ensure you install a compatible version of `tensorflow_addons` for your existing version of
TensorFlow, you can install with the `tensorflow` extra requirement:

```
pip install tensorflow-addons[tensorflow]
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pending the answer to #2111 (comment) I think we could even move this up to the primary "Install TFA" block

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in that issue, reworded this section to clarify that the effect will be to ensure a compatible version of TensorFlow is installed, not the reverse (a compatible TFA for your TF install). Also moved to the Installation section as suggested. Let me know what you think!


Similar extras exist for `tensorflow-gpu` and `tensorflow-cpu`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be happier if tensorflow-gpu was done away with but I think while it exists this is good to use for dependencies


#### Python Op Compatibility Matrix
| TensorFlow Addons | TensorFlow | Python |
|:----------------------- |:---|:---------- |
Expand Down