Edited the tf script mode notebook (aws#90)

* edited tf script mode notebook

Author: eslesar-aws

examples/script_mode_train_any_tf_script_in_sage_maker.ipynb

@@ -4,6 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "# Use Script Mode to train any TensorFlow script from GitHub in SageMaker\n",
     "\n",
@@ -12,28 +13,41 @@
     "For this example, you use [Multi-layer Recurrent Neural Networks (LSTM, RNN) for character-level language models in Python using Tensorflow](https://github.com/sherjilozair/char-rnn-tensorflow), but you can use the same technique for other scripts or repositories. For example, [TensorFlow Model Zoo](https://github.com/tensorflow/models) and [TensorFlow benchmark scripts](https://github.com/tensorflow/benchmarks/tree/master/scripts/tf_cnn_benchmarks)."
 =======
     "# Using the Script Mode to train any TensorFlow script from GitHub in SageMaker\n",
+=======
+    "# Use Script Mode to train any TensorFlow script from GitHub in SageMaker\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "\n",
-    "In this tutorial, we show how simple it is to train a TensorFlow script in SageMaker using the new Script Mode Tensorflow Container.\n",
+    "In this tutorial, you train a TensorFlow script in SageMaker using the new Script Mode Tensorflow Container.\n",
     "\n",
+<<<<<<< HEAD
     "The example we chose is [Multi-layer Recurrent Neural Networks (LSTM, RNN) for character-level language models in Python using Tensorflow](https://github.com/sherjilozair/char-rnn-tensorflow) but this same technique can be used to other scripts or repositories including [TensorFlow Model Zoo](https://github.com/tensorflow/models) and [TensorFlow benchmark scripts](https://github.com/tensorflow/benchmarks/tree/master/scripts/tf_cnn_benchmarks)."
 >>>>>>> Add Script Mode example (#83)
+=======
+    "For this example, you use [Multi-layer Recurrent Neural Networks (LSTM, RNN) for character-level language models in Python using Tensorflow](https://github.com/sherjilozair/char-rnn-tensorflow), but you can use the same technique for other scripts or repositories. For example, [TensorFlow Model Zoo](https://github.com/tensorflow/models) and [TensorFlow benchmark scripts](https://github.com/tensorflow/benchmarks/tree/master/scripts/tf_cnn_benchmarks)."
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
 <<<<<<< HEAD
+<<<<<<< HEAD
+=======
+>>>>>>> Edited the tf script mode notebook (#90)
     "## Set up the environment\n",
     "Let's start by creating a SageMaker session and specifying the following:\n",
     "- The S3 bucket and prefix to use for training and model data. The bucket should be in the same region as the Notebook Instance, training instance(s), and hosting instance(s). This example uses the default bucket that a SageMaker `Session` creates.\n",
     "- The IAM role that allows SageMaker services to access your data. For more information about using IAM roles in SageMaker, see  [Amazon SageMaker Roles](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\n"
+<<<<<<< HEAD
 =======
     "## Setting up the environment\n",
     "Let's start by creating a SageMaker session and specifying:\n",
     "- The S3 bucket and prefix that you want to use for training and model data. It should be within the same region as the Notebook Instance, training, and hosting.\n",
     "- The IAM role allows SageMaker services to access your data. See the documentation [for how to create these](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\n"
 >>>>>>> Add Script Mode example (#83)
+=======
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -55,12 +69,17 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "### Clone the repository\n",
     "Run the following command to clone the repository that contains the example:"
 =======
     "### Clone the repository"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "### Clone the repository\n",
+    "Run the following command to clone the repository that contains the example:"
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -93,12 +112,17 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "### Get the data\n",
     "For training data, use plain text versions of Sherlock Holmes stories."
 =======
     "### Getting the data"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "### Get the data\n",
+    "For training data, use plain text versions of Sherlock Holmes stories."
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -115,11 +139,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "## Test locally"
 =======
     "## Testing locally"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "## Test locally"
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -167,11 +195,15 @@
    "metadata": {},
    "source": [
     "\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "Use [Local Mode](https://github.com/aws/sagemaker-python-sdk#local-mode) to run the script locally in the notebook instance before you run a SageMaker training job:"
 =======
     "We can use [Local Mode](https://github.com/aws/sagemaker-python-sdk#local-mode) to simulate SageMaker locally before submit training:"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "Use [Local Mode](https://github.com/aws/sagemaker-python-sdk#local-mode) to run the script locally in the notebook instance before you run a SageMaker training job:"
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -188,11 +220,15 @@
     "\n",
     "estimator = ScriptModeTensorFlow(entry_point='train.py',\n",
     "                                 source_dir='char-rnn-tensorflow',\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "                                 train_instance_type='local',      # Run in local mode\n",
 =======
     "                                 train_instance_type='local', \n",
 >>>>>>> Add Script Mode example (#83)
+=======
+    "                                 train_instance_type='local',      # Run in local mode\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "                                 train_instance_count=1,\n",
     "                                 hyperparameters=hyperparameters,\n",
     "                                 role=role)\n",
@@ -206,6 +242,7 @@
    "source": [
     "## How Script Mode executes the script in the container\n",
     "\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "The above cell downloads a Python 3 CPU container locally and simulates a SageMaker training job. When training starts, script mode installs the user script as a Python module. The module name matches the script name. In this case, **train.py** is transformed into a Python module named **train**.\n",
     "\n",
@@ -215,15 +252,24 @@
     "\n",
     "After that, the Python interpreter executes the user module, passing **hyperparameters** as script arguments. The example above will be executed as follow:\n",
 >>>>>>> Add Script Mode example (#83)
+=======
+    "The above cell downloads a Python 3 CPU container locally and simulates a SageMaker training job. When training starts, script mode installs the user script as a Python module. The module name matches the script name. In this case, **train.py** is transformed into a Python module named **train**.\n",
+    "\n",
+    "After that, the Python interpreter executes the user module, passing **hyperparameters** as script arguments. The example above is executed as follows:\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "```bash\n",
     "python -m train --num-epochs 1 --data-dir /opt/ml/input/data/training --save-dir /opt/ml/model\n",
     "```\n",
     "\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "The **train** module consumes the hyperparameters using any argument parsing library. [The example we're using](https://github.com/sherjilozair/char-rnn-tensorflow/blob/master/train.py#L11) uses the Python [argparse](https://docs.python.org/3/library/argparse.html) library:\n",
 =======
     "A user provide script consumes the hyperparameters using any argument parsing library, [in the example above](https://github.com/sherjilozair/char-rnn-tensorflow/blob/master/train.py#L11):\n",
 >>>>>>> Add Script Mode example (#83)
+=======
+    "The **train** module consumes the hyperparameters using any argument parsing library. [The example we're using](https://github.com/sherjilozair/char-rnn-tensorflow/blob/master/train.py#L11) uses the Python [argparse](https://docs.python.org/3/library/argparse.html) library:\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "\n",
     "```python\n",
     "parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)\n",
@@ -238,6 +284,7 @@
     "\n",
     "Let's explain the values of **--data_dir** and **--save-dir**:\n",
     "\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "- **/opt/ml/input/data/training** is the directory inside the container where the training data is downloaded. The data is downloaded to this folder because **training** is the channel name defined in ```estimator.fit({'training': inputs})```. See [training data](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html#your-algorithms-training-algo-running-container-trainingdata) for more information. \n",
     "\n",
@@ -251,16 +298,23 @@
     "For example, the example above can read information about the **training** channel provided in the training job request by adding the environment variable `SM_CHANNEL_TRAINING` as the default value for the `--data_dir` argument:\n",
 =======
     "- **/opt/ml/input/data/training** is the directory inside the container where the training data is downloaded. The data was downloaded in this folder because **training** is the channel name defined in ```estimator.fit({'training': inputs})```. See [training data](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html#your-algorithms-training-algo-running-container-trainingdata) for more information. \n",
+=======
+    "- **/opt/ml/input/data/training** is the directory inside the container where the training data is downloaded. The data is downloaded to this folder because **training** is the channel name defined in ```estimator.fit({'training': inputs})```. See [training data](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html#your-algorithms-training-algo-running-container-trainingdata) for more information. \n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "\n",
-    "- **/opt/ml/model** use this directory to save models, checkpoints or any other data. Any data saved in this folder is saved in the S3 bucket defined for training. See [model data](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html#your-algorithms-training-algo-envvariables) for more information.\n",
+    "- **/opt/ml/model** use this directory to save models, checkpoints, or any other data. Any data saved in this folder is saved in the S3 bucket defined for training. See [model data](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-training-algo.html#your-algorithms-training-algo-envvariables) for more information.\n",
     "\n",
     "### Reading additional information from the container\n",
     "\n",
-    "Very often, a user script needs additional information from the container that is not available in ```hyperparameters```.\n",
-    "SageMaker Containers writes this information as **environment variables** that are available inside the script.\n",
+    "Often, a user script needs additional information from the container that is not available in ```hyperparameters```.\n",
+    "SageMaker containers write this information as **environment variables** that are available inside the script.\n",
     "\n",
+<<<<<<< HEAD
     "For example, the example above can read information about the **training** channel provided in the training job request:\n",
 >>>>>>> Add Script Mode example (#83)
+=======
+    "For example, the example above can read information about the **training** channel provided in the training job request by adding the environment variable `SM_CHANNEL_TRAINING` as the default value for the `--data_dir` argument:\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "\n",
     "```python\n",
     "if __name__ == '__main__':\n",
@@ -269,11 +323,15 @@
     "  parser.add_argument('--data_dir', type=str, default=os.environ['SM_CHANNEL_TRAINING'])\n",
     "```\n",
     "\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "Script mode displays the list of available environment variables in the training logs. You can find the [entire list here](https://github.com/aws/sagemaker-containers/blob/master/README.md#environment-variables-full-specification)."
 =======
     "Script Mode displays the list of the environment variables available in the training logs. You can find the [entire list here](https://github.com/aws/sagemaker-containers/blob/master/README.md#environment-variables-full-specification)."
 >>>>>>> Add Script Mode example (#83)
+=======
+    "Script mode displays the list of available environment variables in the training logs. You can find the [entire list here](https://github.com/aws/sagemaker-containers/blob/master/README.md#environment-variables-full-specification)."
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -287,11 +345,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "After you test the training job locally, upload the dataset to an S3 bucket so SageMaker can access the data during training.\n"
 =======
     "We need to upload the dataset to an S3 bucket so SageMaker can access the data during training.\n"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "After you test the training job locally, upload the dataset to an S3 bucket so SageMaker can access the data during training.\n"
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -307,11 +369,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "To train in SageMaker, change the estimator argument **train_instance_type** to any SageMaker ml instance available for training. For example:"
 =======
     "You can change the estimator argument **train_instance_type** to any SageMaker ml instance available for training. For example:"
 >>>>>>> Add Script Mode example (#83)
+=======
+    "To train in SageMaker, change the estimator argument **train_instance_type** to any SageMaker ml instance available for training. For example:"
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -348,11 +414,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+<<<<<<< HEAD
 <<<<<<< HEAD
     "Script Mode installs the contents of your `source_dir` folder in the container as a [Python package](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L100). You can include a [requirements.txt file in the root folder of your source_dir to install any pip dependencies](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L111). You can, for example, install the lastest version of TensorFlow in the container:\n",
 =======
     "Script Mode will install your source_dir in the container as a [Python package](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L100). You can include a [requirements.txt file in the root folder of your source_dir to install any pip dependencies](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L111). You can, for example, install the lastest version of tensorflow in the container:\n",
 >>>>>>> Add Script Mode example (#83)
+=======
+    "Script Mode installs the contents of your `source_dir` folder in the container as a [Python package](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L100). You can include a [requirements.txt file in the root folder of your source_dir to install any pip dependencies](https://github.com/aws/sagemaker-containers/blob/master/src/sagemaker_containers/_modules.py#L111). You can, for example, install the lastest version of TensorFlow in the container:\n",
+>>>>>>> Edited the tf script mode notebook (#90)
     "\n",
     "content of requirements.txt\n",
     "```\n",
@@ -365,11 +435,15 @@
    "metadata": {},
    "source": [
     "# Installing apt-get packages and other dependencies\n",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "You can define a `setup.py` file in your `source_dir` folder to install other dependencies. The example below installs [TensorFlow for C](https://www.tensorflow.org/install/lang_c) in the container."
 =======
     "You can define a setup.py file in your source_dir to install other dependencies. The example below will install [TensorFlow for C](https://www.tensorflow.org/install/lang_c) in the container."
 >>>>>>> Add Script Mode example (#83)
+=======
+    "You can define a `setup.py` file in your `source_dir` folder to install other dependencies. The example below installs [TensorFlow for C](https://www.tensorflow.org/install/lang_c) in the container."
+>>>>>>> Edited the tf script mode notebook (#90)
    ]
   },
   {
@@ -473,6 +547,7 @@
  ],
  "metadata": {
   "kernelspec": {
+<<<<<<< HEAD
 <<<<<<< HEAD
    "display_name": "Python 3",
    "language": "python",
@@ -482,27 +557,41 @@
    "language": "python",
    "name": "python2"
 >>>>>>> Add Script Mode example (#83)
+=======
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+>>>>>>> Edited the tf script mode notebook (#90)
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
+<<<<<<< HEAD
 <<<<<<< HEAD
     "version": 3
 =======
     "version": 2
 >>>>>>> Add Script Mode example (#83)
+=======
+    "version": 3
+>>>>>>> Edited the tf script mode notebook (#90)
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
+<<<<<<< HEAD
 <<<<<<< HEAD
    "pygments_lexer": "ipython3",
    "version": "3.6.5"
 =======
    "pygments_lexer": "ipython2",
    "version": "2.7.15"
 >>>>>>> Add Script Mode example (#83)
+=======
+   "pygments_lexer": "ipython3",
+   "version": "3.6.5"
+>>>>>>> Edited the tf script mode notebook (#90)
   }
  },
  "nbformat": 4,