Skip to content
/ addons Public
forked from tensorflow/addons

Useful extra functionality for TensorFlow 2.0 maintained by SIG-addons

License

Notifications You must be signed in to change notification settings

xuezh01/addons

 
 

Repository files navigation




PyPI Status Badge Gitter chat

Official Builds

Build Type Status
Linux Py2 CPU Status
Linux Py3 CPU Status
Linux Py2 GPU Status
Linux Py3 GPU Status
Linux Sanity Check Status

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 @facaiy @seanpmorgan
tfa.image SIG-Addons @windqaq @facaiy
tfa.layers SIG-Addons @seanpmorgan @facaiy
tfa.losses SIG-Addons @facaiy @windqaq
tfa.optimizers SIG-Addons @facaiy @windqaq
tfa.rnn Google @qlzh727
tfa.seq2seq Google @qlzh727
tfa.text SIG-Addons @seanpmorgan @facaiy

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 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

License

Apache License 2.0

About

Useful extra functionality for TensorFlow 2.0 maintained by SIG-addons

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 87.9%
  • C++ 8.4%
  • Shell 3.6%
  • Other 0.1%