Skip to content

Commit 67d65c6

Browse files
authored
Merge pull request #3691 from tensorflow/readme-run-instructions
Updated README run instructions
2 parents f478547 + 3e5575c commit 67d65c6

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

official/mnist/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ APIs.
1111

1212
## Setup
1313

14-
To begin, you'll simply need the latest version of TensorFlow installed,
15-
and make sure to run the command to export the `/models` folder to the
16-
python path: https://github.com/tensorflow/models/tree/master/official#running-the-models
14+
To begin, you'll simply need the latest version of TensorFlow installed.
15+
First make sure you've [added the models folder to your Python path](/official/#running-the-models); otherwise you may encounter an error like `ImportError: No module named official.mnist`.
1716

1817
Then to train the model, run the following:
1918

official/resnet/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ Please proceed according to which dataset you would like to train/evaluate on:
1818
### Setup
1919

2020
You simply need to have the latest version of TensorFlow installed.
21+
First make sure you've [added the models folder to your Python path](/official/#running-the-models); otherwise you may encounter an error like `ImportError: No module named official.resnet`.
2122

22-
First download and extract the CIFAR-10 data from Alex's website, specifying the location with the `--data_dir` flag. Run the following:
23+
Then download and extract the CIFAR-10 data from Alex's website, specifying the location with the `--data_dir` flag. Run the following:
2324

2425
```
2526
python cifar10_download_and_extract.py

official/wide_deep/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The input function for the `Estimator` uses `tf.contrib.data.TextLineDataset`, w
1515
The `Estimator` and `Dataset` APIs are both highly encouraged for fast development and efficient training.
1616

1717
## Running the code
18-
Make sure to run the command to export the `/models` folder to the python path: https://github.com/tensorflow/models/tree/master/official#running-the-models
18+
First make sure you've [added the models folder to your Python path](/official/#running-the-models); otherwise you may encounter an error like `ImportError: No module named official.wide_deep`.
1919

2020
### Setup
2121
The [Census Income Data Set](https://archive.ics.uci.edu/ml/datasets/Census+Income) that this sample uses for training is hosted by the [UC Irvine Machine Learning Repository](https://archive.ics.uci.edu/ml/datasets/). We have provided a script that downloads and cleans the necessary files.

0 commit comments

Comments
 (0)