Skip to content

Updated README run instructions #3691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 22, 2018
Merged

Updated README run instructions #3691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
41e60b0
Updates to individual official/ README files to make sure users can r…
nealwu Mar 22, 2018
d7ce4e8
Fix the links
nealwu Mar 22, 2018
e78aea7
Link to the folders rather than the README files directly
nealwu Mar 22, 2018
3e5575c
Add the error message the user will run into
nealwu Mar 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions official/mnist/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ APIs.

## Setup

To begin, you'll simply need the latest version of TensorFlow installed,
and 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
To begin, you'll simply need the latest version of TensorFlow installed.
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`.

Then to train the model, run the following:

Expand Down
3 changes: 2 additions & 1 deletion official/resnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Please proceed according to which dataset you would like to train/evaluate on:
### Setup

You simply need to have the latest version of TensorFlow installed.
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`.

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

```
python cifar10_download_and_extract.py
Expand Down
2 changes: 1 addition & 1 deletion official/wide_deep/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The input function for the `Estimator` uses `tf.contrib.data.TextLineDataset`, w
The `Estimator` and `Dataset` APIs are both highly encouraged for fast development and efficient training.

## Running the code
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
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`.

### Setup
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.
Expand Down