Commit d479abde authored by A. Unique TensorFlower's avatar A. Unique TensorFlower
Browse files

Updated official/README.md to be compatible with other README.md's in the model garden

PiperOrigin-RevId: 436857882
parent aa645e71
![Logo](https://storage.googleapis.com/model_garden_artifacts/TF_Model_Garden.png) <div align="center">
<img src="https://storage.googleapis.com/tf_model_garden/tf_model_garden_logo.png">
</div>
# TensorFlow Official Models # TensorFlow Official Models
...@@ -32,6 +34,7 @@ In the near future, we will add: ...@@ -32,6 +34,7 @@ In the near future, we will add:
* [Natural Language Processing](#natural-language-processing) * [Natural Language Processing](#natural-language-processing)
* [Recommendation](#recommendation) * [Recommendation](#recommendation)
- [How to get started with the official models](#how-to-get-started-with-the-official-models) - [How to get started with the official models](#how-to-get-started-with-the-official-models)
- [Contributions](#contributions)
## Models and Implementations ## Models and Implementations
...@@ -92,7 +95,7 @@ built from the ...@@ -92,7 +95,7 @@ built from the
as tagged branches or [downloadable releases](https://github.com/tensorflow/models/releases). as tagged branches or [downloadable releases](https://github.com/tensorflow/models/releases).
* Model repository version numbers match the target TensorFlow release, * Model repository version numbers match the target TensorFlow release,
such that such that
[release v2.5.0](https://github.com/tensorflow/models/releases/tag/v2.5.0) [TensorFlow-models v2.5.0](https://github.com/tensorflow/models/releases/tag/v2.5.0)
is compatible with is compatible with
[TensorFlow v2.5.0](https://github.com/tensorflow/tensorflow/releases/tag/v2.5.0). [TensorFlow v2.5.0](https://github.com/tensorflow/tensorflow/releases/tag/v2.5.0).
...@@ -100,12 +103,13 @@ Please follow the below steps before running models in this repository. ...@@ -100,12 +103,13 @@ Please follow the below steps before running models in this repository.
### Requirements ### Requirements
* The latest TensorFlow Model Garden release and TensorFlow 2 * The latest TensorFlow Model Garden release and the latest TensorFlow 2
* If you are on a version of TensorFlow earlier than 2.2, please * If you are on a version of TensorFlow earlier than 2.2, please
upgrade your TensorFlow to [the latest TensorFlow 2](https://www.tensorflow.org/install/). upgrade your TensorFlow to [the latest TensorFlow 2](https://www.tensorflow.org/install/).
```shell ```shell
pip3 install tf-nightly pip3 install tf-nightly
# pip3 install tensorflow # for latest stable version
``` ```
* Python 3.7+ * Python 3.7+
...@@ -115,65 +119,7 @@ don't recommend earlier versions. ...@@ -115,65 +119,7 @@ don't recommend earlier versions.
### Installation ### Installation
#### Method 1: Install the TensorFlow Model Garden pip package Please check the installation instructions [here](https://github.com/tensorflow/models#Installation)
**tf-models-official** is the stable Model Garden package.
pip will install all models and dependencies automatically.
```shell
pip install tf-models-official
```
If you are using nlp packages, please also install **tensorflow-text**:
```shell
pip 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
pip install tf-models-nightly
```
#### Method 2: Clone the source
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
```
## Contributions ## Contributions
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment