Official Builds
Build Type | Status |
---|---|
Linux Py2 CPU | |
Linux Py3 CPU | |
Linux Py2 GPU | |
Linux Py3 GPU | |
Linux Sanity Check |
TensorFlow Addons is a repository of contributions that conform to well-established API patterns, but implement new functionality not available in core TensorFlow. TensorFlow natively supports a large number of operators, layers, metrics, losses, and optimizers. However, in a fast moving field like ML, there are many interesting new developments that cannot be integrated into core TensorFlow (because their broad applicability is not yet clear, or it is mostly used by a smaller subset of the community).
Maintainers
Subpackage | Maintainers | Contact Info |
---|---|---|
tfa.activations | SIG-Addons | addons@tensorflow.org |
tfa.image | ||
tfa.layers | SIG-Addons | addons@tensorflow.org |
tfa.losses | SIG-Addons | addons@tensorflow.org |
tfa.optimizers | SIG-Addons | addons@tensorflow.org |
tfa.rnn | @qlzh727 | |
tfa.seq2seq | @qlzh727 | |
tfa.text |
Core Concepts
Standardized API within Subpackages
User experience and project maintainability are core concepts in TF-Addons. In order to achieve these we require that our additions conform to established API patterns seen in core TensorFlow.
Periodic Evaluation of Subpackages
Based on the nature of this repository, there will be contributions that in time become dated and unused. In order to keep the project maintainable, SIG-Addons will perform periodic reviews and deprecate contributions which will be slated for removal. More information will be available after we submit a formal request for comment.
Examples
See tensorflow_addons/examples/
for end-to-end examples of various addons.
Installation
Stable Builds
To install the latest version, run the following:
pip install tensorflow-addons
Note: You will also need tensorflow==2.0.0.a0
installed.
To use addons:
import tensorflow as tf
import tensorflow_addons as tfa
Installing from Source
You can also install from source. This requires the Bazel build system.
Note: If building from master you must install tf-nightly-2.0-preview
in the process.
git clone https://github.com/tensorflow/addons.git
cd addons
# This script links project with TensorFlow dependency
./configure.sh
bazel build build_pip_pkg
bazel-bin/build_pip_pkg artifacts
pip install artifacts/tensorflow_addons-*.whl
Contributing
TF-Addons is a community led open source project. As such, the project depends on public contributions, bug-fixes, and documentation. Please see contribution guidelines for a guide on how to contribute. This project adheres to TensorFlow's code of conduct. By participating, you are expected to uphold this code.
Community
- Public Mailing List
- SIG Monthly Meeting Notes
- Join our mailing list and receive calendar invites to the meeting