diff --git a/README.en.md b/README.en.md new file mode 100644 index 00000000..24ce6ff3 --- /dev/null +++ b/README.en.md @@ -0,0 +1,168 @@ +
+ +
+ +[![Python](https://img.shields.io/pypi/pyversions/tensorflow.svg)](https://badge.fury.io/py/tensorflow) +[![PyPI](https://badge.fury.io/py/tensorflow.svg)](https://badge.fury.io/py/tensorflow) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4724125.svg)](https://doi.org/10.5281/zenodo.4724125) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1486/badge)](https://bestpractices.coreinfrastructure.org/projects/1486) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/tensorflow/tensorflow/badge)](https://securityscorecards.dev/viewer/?uri=github.com/tensorflow/tensorflow) +[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/tensorflow.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:tensorflow) +[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/tensorflow-py.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:tensorflow-py) +[![OSSRank](https://shields.io/endpoint?url=https://ossrank.com/shield/44)](https://ossrank.com/p/44) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) + +**`Documentation`** | +------------------- | +[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://www.tensorflow.org/api_docs/) | + +[TensorFlow](https://www.tensorflow.org/) is an end-to-end open source platform +for machine learning. It has a comprehensive, flexible ecosystem of +[tools](https://www.tensorflow.org/resources/tools), +[libraries](https://www.tensorflow.org/resources/libraries-extensions), and +[community](https://www.tensorflow.org/community) resources that lets +researchers push the state-of-the-art in ML and developers easily build and +deploy ML-powered applications. + +TensorFlow was originally developed by researchers and engineers working within +the Machine Intelligence team at Google Brain to conduct research in machine +learning and neural networks. However, the framework is versatile enough to be +used in other areas as well. + +TensorFlow provides stable [Python](https://www.tensorflow.org/api_docs/python) +and [C++](https://www.tensorflow.org/api_docs/cc) APIs, as well as a +non-guaranteed backward compatible API for +[other languages](https://www.tensorflow.org/api_docs). + +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). +See all the [mailing lists](https://www.tensorflow.org/community/forums). + +## Install + +See the [TensorFlow install guide](https://www.tensorflow.org/install) for the +[pip package](https://www.tensorflow.org/install/pip), to +[enable GPU support](https://www.tensorflow.org/install/gpu), use a +[Docker container](https://www.tensorflow.org/install/docker), and +[build from source](https://www.tensorflow.org/install/source). + +To install the current release, which includes support for +[CUDA-enabled GPU cards](https://www.tensorflow.org/install/gpu) *(Ubuntu and +Windows)*: + +``` + pip install tensorflow +``` + +Other devices (DirectX and MacOS-metal) are supported using +[Device Plugins](https://www.tensorflow.org/install/gpu_plugins#available_devices). + +A smaller CPU-only TensorFlow package is also available: + +``` + pip install tensorflow-cpu +``` + +To update TensorFlow to the latest version, add the `--upgrade` flag to the +commands above. + +*Nightly binaries are available for testing using the +[tf-nightly](https://pypi.python.org/pypi/tf-nightly) and +[tf-nightly-cpu](https://pypi.python.org/pypi/tf-nightly-cpu) packages on PyPI.* + +#### *Try your first TensorFlow program* + +```shell +$ python +``` + +```python +>>> import tensorflow as tf +>>> tf.add(1, 2).numpy() +3 +>>> hello = tf.constant('Hello, TensorFlow!') +>>> hello.numpy() +b'Hello, TensorFlow!' +``` + +For more examples, see the +[TensorFlow Tutorials](https://www.tensorflow.org/tutorials/). + +## 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, please see +[TensorFlow Forum](https://discuss.tensorflow.org/) 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. + +## Patching guidelines + +Follow these steps to patch a specific version of TensorFlow, for example, to +apply fixes to bugs or security vulnerabilities: + +* Clone the TensorFlow repository and switch to the appropriate branch for + your desired version—for example, `r2.8` for version 2.8. +* Apply the desired changes (i.e., cherry-pick them) and resolve any code + conflicts. +* Run TensorFlow tests and ensure they pass. +* [Build](https://www.tensorflow.org/install/source) the TensorFlow pip + package from source. + +## Continuous build status + +You can find more community-supported platforms and configurations in the +[TensorFlow SIG Build Community Builds Table](https://github.com/tensorflow/build#community-supported-tensorflow-builds). + +### Official Builds + +Build Type | Status | Artifacts +----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- +**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://bintray.com/google/tensorflow/tensorflow/_latestVersion) +**Raspberry Pi 0 and 1** | [![Status](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py3.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi01-py3.html) | [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-py3.svg)](https://storage.googleapis.com/tensorflow-kokoro-build-badges/rpi23-py3.html) | [Py3](https://storage.googleapis.com/tensorflow-nightly/tensorflow-1.10.0-cp34-none-linux_armv7l.whl) + +## Resources + +* [TensorFlow.org](https://www.tensorflow.org) +* [TensorFlow Tutorials](https://www.tensorflow.org/tutorials/) +* [TensorFlow Official Models](https://github.com/tensorflow/models/tree/master/official) +* [TensorFlow Examples](https://github.com/tensorflow/examples) +* [TensorFlow Codelabs](https://codelabs.developers.google.com/?cat=TensorFlow) +* [TensorFlow Blog](https://blog.tensorflow.org) +* [Learn ML with TensorFlow](https://www.tensorflow.org/resources/learn-ml) +* [TensorFlow Twitter](https://twitter.com/tensorflow) +* [TensorFlow YouTube](https://www.youtube.com/channel/UC0rqucBdTuFTjJiefW5t-IQ) +* [TensorFlow model optimization roadmap](https://www.tensorflow.org/model_optimization/guide/roadmap) +* [TensorFlow White Papers](https://www.tensorflow.org/about/bib) +* [TensorBoard Visualization Toolkit](https://github.com/tensorflow/tensorboard) +* [TensorFlow Code Search](https://cs.opensource.google/tensorflow/tensorflow) + +Learn more about the +[TensorFlow Community](https://www.tensorflow.org/community) and how to +[Contribute](https://www.tensorflow.org/community/contribute). + +## Courses + +* [Coursera](https://www.coursera.org/search?query=TensorFlow) +* [Udacity](https://www.udacity.com/courses/all?search=TensorFlow) +* [Edx](https://www.edx.org/search?q=TensorFlow) + +## License + +[Apache License 2.0](LICENSE)