未验证 提交 99f15f32 编写于 作者: V Vishnuvardhan Janapati 提交者: GitHub

Update README.md (#10551)

* Update README.md

Updating README.md with the installation approach. Also, formatted text for consistency.

* Updated tensorflow/models/README.md

Added markdown code to hide details. User need to clic the triangle symbol to see the details.
This makes the page look better

* Update README.md
上级 e396718a
![Logo](https://storage.googleapis.com/tf_model_garden/tf_model_garden_logo.png)
<div align="center">
<img src="https://storage.googleapis.com/tf_model_garden/tf_model_garden_logo.png">
</div>
[![Python](https://img.shields.io/pypi/pyversions/tensorflow.svg?style=plastic)](https://badge.fury.io/py/tensorflow)
[![PyPI](https://badge.fury.io/py/tensorflow.svg)](https://badge.fury.io/py/tensorflow)
# Welcome to the Model Garden for TensorFlow
......@@ -19,7 +24,88 @@ extent possible though not all models are suitable.
| [community](community) | • A curated list of the GitHub repositories with machine learning models and implementations powered by TensorFlow 2 |
| [orbit](orbit) | • A flexible and lightweight library that users can easily use or fork when writing customized training loop code in TensorFlow 2.x. It seamlessly integrates with `tf.distribute` and supports running on different device types (CPU, GPU, and TPU). |
## [Announcements](https://github.com/tensorflow/models/wiki/Announcements)
## Installation
To install the current release of tensorflow-models, please follow any one of the methods described below.
#### Method 1: Install the TensorFlow Model Garden pip package
<details>
**tf-models-official** is the stable Model Garden package.
pip will install all models and dependencies automatically.
```shell
pip3 install tf-models-official
```
If you are using nlp packages, please also install **tensorflow-text**:
```shell
pip3 install tensorflow-text
```
Please check out our [example](https://github.com/tensorflow/text/blob/master/docs/tutorials/fine_tune_bert.ipynb)
to learn how to use a PIP package.
Note that **tf-models-official** may not include the latest changes in this
github repo. To include latest changes, you may install **tf-models-nightly**,
which is the nightly Model Garden package created daily automatically.
```shell
pip3 install tf-models-nightly
```
If you are using `nlp` packages, please also install tensorflow-text-nightly
```shell
pip3 install tensorflow-text-nightly
```
</details>
#### Method 2: Clone the source
<details>
1. Clone the GitHub repository:
```shell
git clone https://github.com/tensorflow/models.git
```
2. Add the top-level ***/models*** folder to the Python path.
```shell
export PYTHONPATH=$PYTHONPATH:/path/to/models
```
If you are using a Colab notebook, please set the Python path with os.environ.
```python
import os
os.environ['PYTHONPATH'] += ":/path/to/models"
```
3. Install other dependencies
```shell
pip3 install --user -r official/requirements.txt
```
Finally, if you are using nlp packages, please also install
**tensorflow-text-nightly**:
```shell
pip3 install tensorflow-text-nightly
```
</details>
## Announcements
Please check [this page](https://github.com/tensorflow/models/wiki/Announcements) for recent announcements.
## Contributions
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册