README.md 6.7 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.

J
Jacques Pienaar 已提交
25 26 27 28
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 已提交
29
## Installation
30
*See [Installing TensorFlow](https://www.tensorflow.org/get_started/os_setup.html) for instructions on how to install our release binaries or how to build from source.*
E
Eugene Brevdo 已提交
31

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

M
Martin Wicke 已提交
34 35
**Nightly pip packages**
* We are pleased to announce that TensorFlow now offers nightly pip packages
B
Benoit Steiner 已提交
36 37 38 39 40
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 已提交
41

M
Martin Wicke 已提交
42

V
Vijay Vasudevan 已提交
43
#### *Try your first TensorFlow program*
44
```shell
45
$ python
46 47
```
```python
48 49 50
>>> import tensorflow as tf
>>> hello = tf.constant('Hello, TensorFlow!')
>>> sess = tf.Session()
51
>>> sess.run(hello)
52
'Hello, TensorFlow!'
53 54
>>> a = tf.constant(10)
>>> b = tf.constant(32)
V
Vijay Vasudevan 已提交
55
>>> sess.run(a + b)
56
42
J
Jonathan Hseu 已提交
57
>>> sess.close()
58
```
A
Akshay Modi 已提交
59
Learn more examples about how to do specific tasks in TensorFlow at the [tutorials page of tensorflow.org](https://www.tensorflow.org/tutorials/).
60

S
Shanqing Cai 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
## 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 已提交
77 78 79 80 81 82 83 84

## Continuous build status

### Official Builds

| Build Type      | Status | Artifacts |
| ---             | ---    | ---       |
| **Linux CPU**   | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-cc.png) | [pypi](https://pypi.org/project/tf-nightly/) |
85
| **Linux GPU**   | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-gpu-py3.png) | [pypi](https://pypi.org/project/tf-nightly-gpu/) |
D
David 已提交
86
| **Linux XLA**   | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/ubuntu-xla.png) | TBA |
Y
Yifei Feng 已提交
87
| **MacOS**       | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/macos-py2-cc.png) | [pypi](https://pypi.org/project/tf-nightly/) |
88 89 90
| **Windows CPU** | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-cpu.png) | [pypi](https://pypi.org/project/tf-nightly/) |
| **Windows GPU** | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/windows-gpu.png) | [pypi](https://pypi.org/project/tf-nightly-gpu/) |
| **Android**     | ![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/android.png) | [![Download](https://api.bintray.com/packages/google/tensorflow/tensorflow/images/download.svg)](https://bintray.com/google/tensorflow/tensorflow/_latestVersion) |
Y
Yifei Feng 已提交
91 92 93 94 95 96 97 98


### Community Supported Builds

| 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 |
99
| **IBM ppc64le GPU** | [![Build Status](http://powerci.osuosl.org/job/TensorFlow_Ubuntu_16.04_PPC64LE_GPU/badge/icon)](http://powerci.osuosl.org/job/TensorFlow_Ubuntu_16.04_PPC64LE_GPU/) | TBA |
100 101
| **Linux CPU with Intel® MKL-DNN®** | [![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)|[1.9.0 py2.7](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.9.0-cp27-cp27mu-linux_x86_64.whl)<br>[1.9.0 py3.5](https://storage.googleapis.com/intel-optimized-tensorflow/tensorflow-1.9.0-cp35-cp35m-linux_x86_64.whl)<br>[1.9.0 py3.6](https://storage.cloud.google.com/intel-optimized-tensorflow/tensorflow-1.9.0-cp36-cp36m-linux_x86_64.whl) |
Y
Yifei Feng 已提交
102 103


104
## For more information
E
Eugene Brevdo 已提交
105

Y
Yifei Feng 已提交
106
* [TensorFlow Website](https://www.tensorflow.org)
V
Vijay Vasudevan 已提交
107
* [TensorFlow White Papers](https://www.tensorflow.org/about/bib)
M
Michael Case 已提交
108
* [TensorFlow YouTube Channel](https://www.youtube.com/channel/UC0rqucBdTuFTjJiefW5t-IQ)
A
Andrew Harp 已提交
109
* [TensorFlow Model Zoo](https://github.com/tensorflow/models)
P
Patrick Nguyen 已提交
110
* [TensorFlow MOOC on Udacity](https://www.udacity.com/course/deep-learning--ud730)
Y
Yifei Feng 已提交
111
* [TensorFlow Course at Stanford](https://web.stanford.edu/class/cs20si)
E
Eugene Brevdo 已提交
112

V
Vijay Vasudevan 已提交
113
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 已提交
114 115 116 117

## License

[Apache License 2.0](LICENSE)