README.md 10.5 KB
Newer Older
V
Vijay Vasudevan 已提交
1 2 3
<div align="center">
  <img src="https://www.tensorflow.org/images/tf_logo_transp.png"><br><br>
</div>
4

V
Vijay Vasudevan 已提交
5
-----------------
6

S
Shanqing Cai 已提交
7

Y
Yifei Feng 已提交
8 9 10
| **`Documentation`** |
|-----------------|
| [![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://www.tensorflow.org/api_docs/) |
11

V
Vijay Vasudevan 已提交
12
**TensorFlow** is an open source software library for numerical computation using
V
Vijay Vasudevan 已提交
13
data flow graphs.  The graph nodes represent mathematical operations, while
14
the graph edges represent the multidimensional data arrays (tensors) that flow
M
Michael Case 已提交
15
between them.  This flexible architecture enables you to deploy computation to one
16
or more CPUs or GPUs in a desktop, server, or mobile device without rewriting
17
code.  TensorFlow also includes [TensorBoard](https://www.tensorflow.org/guide/summaries_and_tensorboard), a data visualization toolkit.
D
Dan Mané 已提交
18 19

TensorFlow was originally developed by researchers and engineers
S
Shanqing Cai 已提交
20
working on the Google Brain team within Google's Machine Intelligence Research
21 22 23 24
organization for the purposes of conducting machine learning and deep neural
networks research.  The system is general enough to be applicable in a wide
variety of other domains, as well.

M
melvinljy96 已提交
25 26
TensorFlow provides stable Python API and C APIs as well as without API backwards compatibility guarantee like C++, Go, Java, JavaScript and Swift.

J
Jacques Pienaar 已提交
27 28 29 30
Keep up to date with release announcements and security updates by
subscribing to
[announce@tensorflow.org](https://groups.google.com/a/tensorflow.org/forum/#!forum/announce).

V
Vijay Vasudevan 已提交
31
## Installation
M
Mark Daoust 已提交
32 33

To install the current release for CPU-only:
M
Muhammad Wildan 已提交
34

35 36 37
```
pip install tensorflow
```
M
Muhammad Wildan 已提交
38

M
Mark Daoust 已提交
39
Use the GPU package for CUDA-enabled GPU cards:
M
Muhammad Wildan 已提交
40

41 42 43
```
pip install tensorflow-gpu
```
M
Muhammad Wildan 已提交
44

45 46
*See [Installing TensorFlow](https://www.tensorflow.org/install) for detailed
instructions, and how to build from source.*
E
Eugene Brevdo 已提交
47

S
Shanqing Cai 已提交
48
People who are a little more adventurous can also try our nightly binaries:
E
Eugene Brevdo 已提交
49

M
Martin Wicke 已提交
50 51
**Nightly pip packages**
* We are pleased to announce that TensorFlow now offers nightly pip packages
B
Benoit Steiner 已提交
52 53 54 55 56
under the [tf-nightly](https://pypi.python.org/pypi/tf-nightly) and
[tf-nightly-gpu](https://pypi.python.org/pypi/tf-nightly-gpu) project on pypi.
Simply run `pip install tf-nightly` or `pip install tf-nightly-gpu` in a clean
environment to install the nightly TensorFlow build. We support CPU and GPU
packages on Linux, Mac, and Windows.
V
Vijay Vasudevan 已提交
57

M
Martin Wicke 已提交
58

V
Vijay Vasudevan 已提交
59
#### *Try your first TensorFlow program*
60
```shell
61
$ python
62 63
```
```python
64
>>> import tensorflow as tf
65 66 67
>>> tf.enable_eager_execution()
>>> tf.add(1, 2)
3
68
>>> hello = tf.constant('Hello, TensorFlow!')
69
>>> hello.numpy()
70
'Hello, TensorFlow!'
71
```
A
Akshay Modi 已提交
72
Learn more examples about how to do specific tasks in TensorFlow at the [tutorials page of tensorflow.org](https://www.tensorflow.org/tutorials/).
73

S
Shanqing Cai 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
## Contribution guidelines

**If you want to contribute to TensorFlow, be sure to review the [contribution
guidelines](CONTRIBUTING.md). This project adheres to TensorFlow's
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
uphold this code.**

**We use [GitHub issues](https://github.com/tensorflow/tensorflow/issues) for
tracking requests and bugs. So please see
[TensorFlow Discuss](https://groups.google.com/a/tensorflow.org/forum/#!forum/discuss) for general questions
and discussion, and please direct specific questions to [Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow).**

The TensorFlow project strives to abide by generally accepted best practices in open-source software development:

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1486/badge)](https://bestpractices.coreinfrastructure.org/projects/1486)

Y
Yifei Feng 已提交
90 91 92 93 94 95 96

## Continuous build status

### Official Builds

| Build Type      | Status | Artifacts |
| ---             | ---    | ---       |
M
Michael Case 已提交
97 98 99 100 101 102 103
| **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/) |
| **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/) |
| **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 |
| **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/) |
| **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/) |
| **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/) |
| **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) |
104 105
| **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) |
| **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) |
Y
Yifei Feng 已提交
106 107 108 109


### Community Supported Builds

110 111 112 113 114 115 116 117
Build Type                                                                                                                                     | Status                                                                                                                                                                                   | Artifacts
---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------
**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
**IBM ppc64le CPU**                                                                                                                            | [![Build Status](http://powerci.osuosl.org/job/TensorFlow_Ubuntu_16.04_CPU/badge/icon)](http://powerci.osuosl.org/job/TensorFlow_Ubuntu_16.04_CPU/)                                      | TBA
**IBM ppc64le GPU** Nightly                                                                                                                    | [![Build Status](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Nightly_Artifact/badge/icon)](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Nightly_Artifact/)            | [Nightly](https://powerci.osuosl.org/job/TensorFlow_PPC64LE_GPU_Nightly_Artifact/)
**IBM 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/)
**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/)
**Linux CPU with Intel® MKL-DNN** Python 2.7<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.10.0 py2.7](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.10.0-cp27-cp27mu-linux_x86_64.whl)<br>[1.10.0 py3.5](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.10.0-cp35-cp35m-linux_x86_64.whl)<br>[1.10.0 py3.6](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.10.0-cp36-cp36m-linux_x86_64.whl)
Y
Yifei Feng 已提交
118

119
## For more information
120 121 122 123
* [TensorFlow Website](https://www.tensorflow.org)
* [TensorFlow Tutorials](https://www.tensorflow.org/tutorials/)
* [TensorFlow Model Zoo](https://github.com/tensorflow/models)
* [TensorFlow Twitter](https://twitter.com/tensorflow)
S
R  
Santosh Kumar 已提交
124
* [TensorFlow Blog](https://medium.com/tensorflow)
M
melvinljy96 已提交
125
* [TensorFlow Course at Stanford](https://web.stanford.edu/class/cs20si)
M
melvinljy96 已提交
126
* [TensorFlow Roadmap](https://www.tensorflow.org/community/roadmap)
V
Vijay Vasudevan 已提交
127
* [TensorFlow White Papers](https://www.tensorflow.org/about/bib)
M
Michael Case 已提交
128
* [TensorFlow YouTube Channel](https://www.youtube.com/channel/UC0rqucBdTuFTjJiefW5t-IQ)
E
Eugene Brevdo 已提交
129

V
Vijay Vasudevan 已提交
130
Learn more about the TensorFlow community at the [community page of tensorflow.org](https://www.tensorflow.org/community) for a few ways to participate.
J
Jonathan Hseu 已提交
131 132 133 134

## License

[Apache License 2.0](LICENSE)