README.md
1<div align="center">
2 <img src="https://www.tensorflow.org/images/tf_logo_transp.png"><br><br>
3</div>
4
5-----------------
6
7
8| **`Documentation`** |
9|-----------------|
10| [![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://www.tensorflow.org/api_docs/) |
11
12**TensorFlow** is an open source software library for numerical computation
13using data flow graphs. The graph nodes represent mathematical operations, while
14the graph edges represent the multidimensional data arrays (tensors) that flow
15between them. This flexible architecture enables you to deploy computation to
16one or more CPUs or GPUs in a desktop, server, or mobile device without
17rewriting code. TensorFlow also includes
18[TensorBoard](https://github.com/tensorflow/tensorboard), a data visualization
19toolkit.
20
21TensorFlow was originally developed by researchers and engineers
22working on the Google Brain team within Google's Machine Intelligence Research
23organization for the purposes of conducting machine learning and deep neural
24networks research. The system is general enough to be applicable in a wide
25variety of other domains, as well.
26
27TensorFlow provides stable Python and C APIs as well as non-guaranteed backwards
28compatible API's for C++, Go, Java, JavaScript and Swift.
29
30Keep up to date with release announcements and security updates by
31subscribing to
32[announce@tensorflow.org](https://groups.google.com/a/tensorflow.org/forum/#!forum/announce).
33
34## Installation
35
36To install the current release for CPU-only:
37
38```
39pip install tensorflow
40```
41
42Use the GPU package for CUDA-enabled GPU cards:
43
44```
45pip install tensorflow-gpu
46```
47
48*See [Installing TensorFlow](https://www.tensorflow.org/install) for detailed
49instructions, and how to build from source.*
50
51People who are a little more adventurous can also try our nightly binaries:
52
53**Nightly pip packages**
54* We are pleased to announce that TensorFlow now offers nightly pip packages
55under the [tf-nightly](https://pypi.python.org/pypi/tf-nightly) and
56[tf-nightly-gpu](https://pypi.python.org/pypi/tf-nightly-gpu) project on pypi.
57Simply run `pip install tf-nightly` or `pip install tf-nightly-gpu` in a clean
58environment to install the nightly TensorFlow build. We support CPU and GPU
59packages on Linux, Mac, and Windows.
60
61#### *Try your first TensorFlow program*
62
63```shell
64$ python
65```
66
67```python
68>>> import tensorflow as tf
69>>> tf.enable_eager_execution()
70>>> tf.add(1, 2).numpy()
713
72>>> hello = tf.constant('Hello, TensorFlow!')
73>>> hello.numpy()
74'Hello, TensorFlow!'
75```
76
77Learn more examples about how to do specific tasks in TensorFlow at the
78[tutorials page of tensorflow.org](https://www.tensorflow.org/tutorials/).
79
80## Contribution guidelines
81
82**If you want to contribute to TensorFlow, be sure to review the [contribution
83guidelines](CONTRIBUTING.md). This project adheres to TensorFlow's
84[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
85uphold this code.**
86
87**We use [GitHub issues](https://github.com/tensorflow/tensorflow/issues) for
88tracking requests and bugs, so please see
89[TensorFlow Discuss](https://groups.google.com/a/tensorflow.org/forum/#!forum/discuss)
90for general questions and discussion, and please direct specific questions to
91[Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow).**
92
93The TensorFlow project strives to abide by generally accepted best practices in open-source software development:
94
95[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1486/badge)](https://bestpractices.coreinfrastructure.org/projects/1486)
96
97
98## Continuous build status
99
100### Official Builds
101
102| Build Type | Status | Artifacts |
103| --- | --- | --- |
104| **Linux CPU** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-cc.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-cc.html) | [pypi](https://pypi.org/project/tf-nightly/) |
105| **Linux GPU** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-gpu-py3.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-gpu-py3.html) | [pypi](https://pypi.org/project/tf-nightly-gpu/) |
106| **Linux XLA** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-xla.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-xla.html) | TBA |
107| **MacOS** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/macos-py2-cc.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/macos-py2-cc.html) | [pypi](https://pypi.org/project/tf-nightly/) |
108| **Windows CPU** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-cpu.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-cpu.html) | [pypi](https://pypi.org/project/tf-nightly/) |
109| **Windows GPU** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-gpu.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-gpu.html) | [pypi](https://pypi.org/project/tf-nightly-gpu/) |
110| **Android** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/android.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/android.html) | [![Download](https://api.bintray.com/packages/google/tensorflow/tensorflow/images/download.svg)](https://bintray.com/google/tensorflow/tensorflow/_latestVersion) |
111| **Raspberry Pi 0 and 1** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py2.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py2.html) [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py3.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py3.html) | [Py2](https://storage.googleapis.com/tensorflow-nightly/tensorflow-1.10.0-cp27-none-linux_armv6l.whl) [Py3](https://storage.googleapis.com/tensorflow-nightly/tensorflow-1.10.0-cp34-none-linux_armv6l.whl) |
112| **Raspberry Pi 2 and 3** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi23-py2.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi23-py2.html) [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi23-py3.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi23-py3.html) | [Py2](https://storage.googleapis.com/tensorflow-nightly/tensorflow-1.10.0-cp27-none-linux_armv7l.whl) [Py3](https://storage.googleapis.com/tensorflow-nightly/tensorflow-1.10.0-cp34-none-linux_armv7l.whl) |
113
114
115### Community Supported Builds
116
117Build Type | Status | Artifacts
118----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------
119**IBM s390x** | [![Build Status](http://ibmz-ci.osuosl.org/job/TensorFlow_IBMZ_CI/badge/icon)](http://ibmz-ci.osuosl.org/job/TensorFlow_IBMZ_CI/) | TBA
120**Linux ppc64le CPU** Nightly | [![Build Status](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Build/badge/icon)](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Build/) | [Nightly](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Nightly_Artifact/)
121**Linux ppc64le CPU** Stable Release | [![Build Status](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Release_Build/badge/icon)](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Release_Build/) | [Release](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_CPU_Release_Build/)
122**Linux ppc64le GPU** Nightly | [![Build Status](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Build/badge/icon)](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Build/) | [Nightly](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Nightly_Artifact/)
123**Linux ppc64le GPU** Stable Release | [![Build Status](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Release_Build/badge/icon)](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Release_Build/) | [Release](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Release_Build/)
124**Linux CPU with Intel® MKL-DNN** Nightly | [![Build Status](https://tensorflow-ci.intel.com/job/tensorflow-mkl-linux-cpu/badge/icon)](https://tensorflow-ci.intel.com/job/tensorflow-mkl-linux-cpu/) | [Nightly](https://tensorflow-ci.intel.com/job/tensorflow-mkl-build-whl-nightly/)
125**Linux CPU with Intel® MKL-DNN** Python 2.7<br> **Linux CPU with Intel® MKL-DNN** Python 3.4<br> **Linux CPU with Intel® MKL-DNN** Python 3.5<br> **Linux CPU with Intel® MKL-DNN** Python 3.6 | [![Build Status](https://tensorflow-ci.intel.com/job/tensorflow-mkl-build-release-whl/badge/icon)](https://tensorflow-ci.intel.com/job/tensorflow-mkl-build-release-whl/lastStableBuild) | [1.12.0 py2.7](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.12.0-cp27-cp27mu-linux_x86_64.whl)<br>[1.12.0 py3.4](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.12.0-cp34-cp34m-linux_x86_64.whl)<br>[1.12.0 py3.5](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.12.0-cp35-cp35m-linux_x86_64.whl)<br>[1.12.0 py3.6](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.12.0-cp36-cp36m-linux_x86_64.whl)
126
127## For more information
128
129* [TensorFlow Website](https://www.tensorflow.org)
130* [TensorFlow Tutorials](https://www.tensorflow.org/tutorials/)
131* [TensorFlow Model Zoo](https://github.com/tensorflow/models)
132* [TensorFlow Twitter](https://twitter.com/tensorflow)
133* [TensorFlow Blog](https://medium.com/tensorflow)
134* [TensorFlow Course at Stanford](https://web.stanford.edu/class/cs20si)
135* [TensorFlow Roadmap](https://www.tensorflow.org/community/roadmap)
136* [TensorFlow White Papers](https://www.tensorflow.org/about/bib)
137* [TensorFlow YouTube Channel](https://www.youtube.com/channel/UC0rqucBdTuFTjJiefW5t-IQ)
138* [TensorFlow Visualization Toolkit](https://github.com/tensorflow/tensorboard)
139
140Learn more about the TensorFlow community at the [community page of tensorflow.org](https://www.tensorflow.org/community) for a few ways to participate.
141
142## License
143
144[Apache License 2.0](LICENSE)
145