@@ -39,6 +39,52 @@ developments that cannot be integrated into core TensorFlow
3939| [ tfa.seq2seq] ( tensorflow_addons/seq2seq/README.md ) | Google | @qlzh727 |
4040| [ tfa.text] ( tensorflow_addons/text/README.md ) | SIG-Addons | @seanpmorgan @facaiy |
4141
42+ ## Installation
43+ #### Stable Builds
44+ To install the latest version, run the following:
45+ ```
46+ pip install tensorflow-addons
47+ ```
48+
49+ ** Note:** You will also need [ ` tensorflow==2.0.0.a0 ` ] ( https://www.tensorflow.org/alpha ) installed.
50+
51+ To use addons:
52+
53+ ``` python
54+ import tensorflow as tf
55+ import tensorflow_addons as tfa
56+ ```
57+
58+ #### Nightly Builds
59+ There are also nightly builds of TensorFlow Addons under the pip package
60+ ` tfa-nightly ` , which is built against ` tf-nightly-2.0-preview ` . Nightly builds
61+ include newer features, but may be less stable than the versioned releases.
62+
63+ ```
64+ pip install tfa-nightly
65+ ```
66+
67+ #### Installing from Source
68+ You can also install from source. This requires the [ Bazel] (
69+ https://bazel.build/ ) build system.
70+
71+ ```
72+ git clone https://github.com/tensorflow/addons.git
73+ cd addons
74+
75+ # This script links project with TensorFlow dependency
76+ ./configure.sh
77+
78+ bazel build build_pip_pkg
79+ bazel-bin/build_pip_pkg artifacts
80+
81+ pip install artifacts/tensorflow_addons-*.whl
82+ ```
83+
84+ ## Examples
85+ See [ ` examples/ ` ] ( examples/ )
86+ for end-to-end examples of various addons.
87+
4288## Core Concepts
4389
4490#### Standardized API within Subpackages
@@ -94,45 +140,6 @@ warning.
941402 . 90 days gives maintainers ample time to fix their code.
95141
96142
97- ## Examples
98- See [ ` examples/ ` ] ( examples/ )
99- for end-to-end examples of various addons.
100-
101- ## Installation
102- #### Stable Builds
103- To install the latest version, run the following:
104- ```
105- pip install tensorflow-addons
106- ```
107-
108- ** Note:** You will also need [ ` tensorflow==2.0.0.a0 ` ] ( https://www.tensorflow.org/alpha ) installed.
109-
110- To use addons:
111-
112- ``` python
113- import tensorflow as tf
114- import tensorflow_addons as tfa
115- ```
116-
117- #### Installing from Source
118- You can also install from source. This requires the [ Bazel] (
119- https://bazel.build/ ) build system.
120-
121- ** Note:** If building from master you must install ` tf-nightly-2.0-preview ` in the process.
122-
123- ```
124- git clone https://github.com/tensorflow/addons.git
125- cd addons
126-
127- # This script links project with TensorFlow dependency
128- ./configure.sh
129-
130- bazel build build_pip_pkg
131- bazel-bin/build_pip_pkg artifacts
132-
133- pip install artifacts/tensorflow_addons-*.whl
134- ```
135-
136143## Contributing
137144TF-Addons is a community led open source project. As such, the project
138145depends on public contributions, bug-fixes, and documentation. Please
0 commit comments