Tac Fix_Working w/Experiments Fix; Other (#2005)

* Link 7.6 * Minor Nit * TaC * Not Needed Left over and should be removed * Added to fix link * Wrong location * Added to fix link * nctl Commands Alpha Sort * Fixed Links-Alpha Sort * Links Fixed-Alpha Sort * Updated OS Info * Updated Link * Link Updates & Legal Link * Return Link * Minor Link Update * Added to Fix Link (Alpha Sorted) * Minor Link Fix * Minor Link Fix * RedHat/Red Hat * No real update * Minor Link Tweak * Link tweak * Link Tweak * Link Tweak * Example Folder update * Last min change * Update template_packs.md
intel · Oct 14, 2019 · 10cb87b · 10cb87b
1 parent 92cf2ea
commit 10cb87b
Show file tree

Hide file tree

Showing 14 changed files with 52 additions and 69 deletions.
diff --git a/docs/installation-and-configuration/Front-Matter (page_Ver_Rev_Legal).md b/docs/installation-and-configuration/Front-Matter (page_Ver_Rev_Legal).md
diff --git a/docs/installation-and-configuration/Installer_System_Requirements/ISR.md b/docs/installation-and-configuration/Installer_System_Requirements/ISR.md
@@ -5,7 +5,7 @@ A separate system (installer system) is required for installing Nauta.  This sec
 ## Nauta Supported Operating Systems
 
 Nauta supports the following Operating Systems: 
-  * RedHat Enterprise Linux 7.6 or CentOS 7.6
+  * Red Hat Enterprise Linux 7.6 or CentOS 7.6
   * Ubuntu 16.04
 
 ### Red Hat Enterprise Linux 7.6

diff --git a/docs/installation-and-configuration/Inventory_Tasks/IT.md b/docs/installation-and-configuration/Inventory_Tasks/IT.md
@@ -6,7 +6,7 @@ Your Nauta cluster will contain one Master node and one or more Worker nodes. Ea
 
 This section discusses the following main topics: 
 
-- [Inventory File Configuration Example](#inventory-file-configuration-example)  
+- [Inventory File Configuration Example](#inventory-configuration-file-example)  
 - [Inventory File Structure](#inventory-file-structure)
 - [Per-node Inventory Variables](#per-node-inventory-variables)
 

diff --git a/docs/installation-and-configuration/Target_Host_Requirements/THR.md b/docs/installation-and-configuration/Target_Host_Requirements/THR.md
@@ -9,11 +9,11 @@ For the _Target host_, install Nauta **on bare metal only** with Red Hat Enterpr
 
 This section discusses the following main topics: 
 
-- [Red Hat Enterprise Linux 7.5](#red-hat-enterprise-linux)  
+- [Red Hat Enterprise Linux 7.6](#red-hat-enterprise-linux)  
 - [Valid Repositories](#valid-repositories)  
 - [Repositories List](#repositories-list)
 
-## Red Hat Enterprise Linux 7.6
+## Red Hat Enterprise Linux
 
 Red Hat Enterprise Linux 7.6 is required, as well as the following required packages: 
 

diff --git a/docs/installation-and-configuration/Troubleshooting/T.md b/docs/installation-and-configuration/Troubleshooting/T.md
@@ -4,8 +4,8 @@ This section provides information related to Nauta-related issues, descriptions,
 
 This section discusses the following main topics: 
 
-- [Jupyter Error 1](#jupyter-error-1-cause)  
-- [Jupyter Error 2](#jupyter-error-2-cause)
+- [Jupyter Error 1](#jupyter-error-1)  
+- [Jupyter Error 2](#jupyter-error-2)
 - [Docker Error](#docker-error)
 - [Removal of Docker Images](#removal-of-docker-images)  
 - [User Management Error](#user-management-error)

diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -9,8 +9,7 @@ Templates are available (and customizable) on the platform to take the complexit
 
 The Nauta client software has been validated on the following operating systems and versions:
 
-* kubectl version  1.15 or later, refer to: [Install Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl)
-* git version 1.8.3.1 or later 
+* Ubuntu (16.04, 18.04)
 * Red Hat 7.6
 * macOS High Sierra (10.13)
 

diff --git a/docs/user-guide/actions/batch_inf_example.md b/docs/user-guide/actions/batch_inf_example.md
@@ -17,13 +17,13 @@ Below are the general steps required to run batch inference on Nauta.
 
 1. Acquire the dataset and the trained model.
 
-1. Convert the dataset into _Serialized Protocol Buffers_ (PBs). Refer to [Protocol Buffers](https://developers.google.com/protocol-buffers) for additional PB information.
+2. Convert the dataset into _Serialized Protocol Buffers_ (PBs). Refer to [Protocol Buffers](https://developers.google.com/protocol-buffers) for additional PB information.
 
-1. Mount the Samba shared folder by invoking the `nctl mount`command (see the example for further details).
+3. Mount the Samba shared folder by invoking the `nctl mount`command (see the example for further details).
 
-1. Copy the serialized PBs and the trained model to the just-mounted share folder.
+4. Copy the serialized PBs and the trained model to the just-mounted share folder.
 
-1. Run `nctl predict batch` command.
+5. Run `nctl predict batch` command.
 
 **Note:** Be aware, if the general flow requirements are not met you will not be able to complete the example.
 
@@ -48,7 +48,7 @@ You _must_ preprocess MNIST data for feeding the batch inference. You can genera
 
 3. Create a directory with two subdirectories named input and output.
 
-4. Run the `mnist_converter_pb.py` (from nauta/applications/cli/example-python/package_examples) using just-generated venv:
+4. Run the `mnist_converter_pb.py` (from the installed examples folder) using just-generated venv:
 
    ```
    python mnist_converter_pb.py
@@ -59,7 +59,7 @@ You _must_ preprocess MNIST data for feeding the batch inference. You can genera
 
 * `work_dir` - Location where files related with conversion will be stored. The default is: `/tmp/mnist_tests`.
 
-* `num_tests` - Number of examples to convert.  Te default is: `100`.
+* `num_tests` - Number of examples to convert.  The default is: `100`.
 
 ## Start Prediction
 

diff --git a/docs/user-guide/actions/getting_started.md b/docs/user-guide/actions/getting_started.md
@@ -111,20 +111,19 @@ The examples folder in the nctl installation contains these following experiment
 * `mnist_converter_pb.py` - This a utility script used for the inference process and model verification.
 * `mnist_horovod.py` - Training of digit classifier in Horovod.
 * `mnist_input_data.py` - Functions for downloading and reading mnist data.
-* `mnist_single_node.py` - Training of digit classifier in single node setting.
+* `mnist_single_node.py` - Training of digit classifier in single node setting  (requires `mnist_inut_data.py` file).
 * `mnist_multinode.py` - Training of digit classifier in distributed TensorFlow setting.
-* `mnist_saved_model.py` - Training of digit classifier with saving the model at the end (requires mnist_input_data.py file).
-* `mnist_tensorboard.py` - Training of digit classifier which displays summaries in TensorBoard (requires at least 2Gi of memory).
+* `mnist_saved_model.py` - Training of digit classifier with saving the model at the end (requires `mnist_tensorboard.py` file).
 
 Additional example scripts for various neural networks  are included and have been validated on the Nauta platform.
 
 ### Utility Scripts
 
 The following are the utility scripts used for the inference process and model verification:
 
-`mnist_converter_pb.py` 
+* `mnist_converter_pb.py` 
 
-`mnist_checker.py`
+* `mnist_checker.py`
 
 **Note:** Experiment scripts _must be_ written in Python.  
 

diff --git a/docs/user-guide/actions/launch_jupyter.md b/docs/user-guide/actions/launch_jupyter.md
@@ -3,8 +3,7 @@
 
 Use the Jupyter Notebook to run and display the results of your experiments. This section discusses the following main topics:
 
- - [Launching Jupyter Interactive Notebook](#launching-jupyter-interactive-notebook)
- - [Storage and Session Data](#storage-and-session-data)  
+ - [Launching Jupyter Interactive Notebook Instructions](#launching-jupyter-interactive-notebook-instructions)
  - [Tunneling](#tunneling)
  - [Canceling a Jupyter Notebook](#canceling-a-jupyter-notebook)
 

diff --git a/docs/user-guide/actions/managing_users_resources.md b/docs/user-guide/actions/managing_users_resources.md
@@ -6,3 +6,11 @@ This section discusses the following topics:
 * [Deleting a User Account](delete_user.md)
 * [Viewing all User Activity](view_user_act.md)
 * [Accessing the Kubernetes Dashboard](accessing_kubernetes.md)
+
+
+----------------------
+
+## Return to Start of Document
+
+* [README](../README.md)
+----------------------
diff --git a/docs/user-guide/actions/template_packs.md b/docs/user-guide/actions/template_packs.md
@@ -178,7 +178,7 @@ Once a _working_ Helm chart is available, the process of adapting it for use as
 
 1. Name the Pack.
 
-   The name should be unique _and not_ conflict with any other packs available in the local [packs](#packs) folder. After      naming the pack, create a corresponding directory in the [packs](#packs) folder and populate its [charts](#charts)          subfolder with the contents of the chart. _Do not_ forget to set this pack name also in the chart.yaml file. Otherwise,      the new template _will not_ work.
+   The name should be unique _and not_ conflict with any other packs available in the local packs folder. After naming the pack, create a corresponding directory in the packs folder and populate its [charts](#charts) subfolder with the contents of the chart. _Do not_ forget to set this pack name also in the chart.yaml file. Otherwise, the new template _will not_ work.
 
    Instead of creating a completely new folder from scratch, you can also copy an existing one using the `nctl template copy` command and modify its content according to your needs. 
 

diff --git a/docs/user-guide/actions/view_cli_help.md b/docs/user-guide/actions/view_cli_help.md
@@ -49,16 +49,16 @@ You can view command-help for any command and available subcommand(s). The follo
 
 ## Other nctl Commands
 
+* [nctl config](config.md)
 * [nctl experiment](experiment.md)
 * [nctl launch](launch.md)
+* [nctl model](model.md)
 * [nctl mount](mount.md)
 * [nctl predict](predict.md)
+* [nctl template](template.md)
 * [nctl user](user.md)
 * [nctl verify](verify.md)
 * [nctl version](version.md)
-* [nctl config](config.md)
-* [nctl model](model.md)
-
 
 ----------------------
 

diff --git a/docs/user-guide/actions/view_exp.md b/docs/user-guide/actions/view_exp.md
@@ -3,7 +3,7 @@
 This section discusses the following main topics: 
 
  - [Viewing All Experiments Using the CLI](#viewing-all-experiments-using-the-cli)
- - [Viewing a Single Experiment's Details](#viewing-a-single-experiment-details)
+ - [Viewing a Single Experiments Details](#viewing-a-single-experiments-details)
  - [Useful References](#useful-references)
 
 ## Viewing All Experiments Using the CLI
@@ -52,7 +52,7 @@ The following _example results_ are shown below (scroll right to see full conten
 
 ```
 
-### Viewing a Single Experiment's Details
+### Viewing a Single Experiments Details
 
 The primary purpose of the next command is to provide Kubernetes pod-level information and container information for this experiment. This includes the pod ID, the POD status, information about input and output volumes used in this experiment, and CPU and memory resources requested to perform this experiment.
 

diff --git a/docs/user-guide/actions/working_with_experiments.md b/docs/user-guide/actions/working_with_experiments.md
@@ -0,0 +1,20 @@
+# Working with Experiments
+
+Use these links to learn about:
+
+* [Cancelling Experiments](cancel_exp.md)
+* [Launching Jupyter Interactive Notebook](launch_jupyter.md)
+* [Mounting Storage to View Experiment Output](mount_exp_output.md)
+* [Run an Experiment on Multiple Nodes](submit_mult_nodes.md)
+* [Run an Experiment using Pytorch Framework](submit_pytorch.md)
+* [Submitting a Single Experiment](submit_single_exp.md)
+* [Submitting Multiple Experiments](submit_mult_exp.md)
+* [Working with Template Packs](template_packs.md)
+
+----------------------
+
+## Return to Start of Document
+
+* [README](../README.md)
+----------------------
+