Merge pull request #6437 from JohnSnowLabs/docs/libs-install

updated installation instructions

Author: diatrambitas

docs/en/licensed_install.md

@@ -13,61 +13,68 @@ sidebar:
 
 ## Install NLP libraries on Ubuntu 
 
-For installing John Snow Labs NLP on an Ubuntu machine/VM please run the following command:
+For installing John Snow Labs NLP libraries on an Ubuntu machine/VM please run the following command:
 
 ```bash
 wget https://setup.johnsnowlabs.com/nlp/install.sh -O - | sudo bash -s -- -a PATH_TO_LICENSE_JSON_FILE -i -r
 ```
 
+This script will install `Spark NLP`, `Spark NLP for Healthcare`, `Spark OCR`, `NLU` and `Spark NLP Display` on the specified virtual environment. It will also create a special folder, `./JohnSnowLabs`,  dedicated to all resources necessary for using the libraries.  Under `./JohnSnowLabs/example_notebooks` you will find some ready to use example notebooks that you can use to test the libraries on your data. 
+
 The install script offers several options:
- - *-h*    show brief help
- - *-i*    install mode: create a virtual environment and install the library
- - *-r*    run mode: start jupyter after installation of the library 
- - *-v*    path to virtual environment (default: ./sparknlp_env)
- - *-j*    path to license json file for Spark NLP for Healthcare
- - *-o*    path to license json file for Spark OCR
- - *-a*    path to a single license json file for both Spark OCR and Spark NLP
- - *-s*    specify pyspark version
- - *-p*    specify port of jupyter notebook
+ - `-h`    show brief help
+ - `-i`    install mode: create a virtual environment and install the library
+ - `-r`    run mode: start jupyter after installation of the library 
+ - `-v`    path to virtual environment (default: ./sparknlp_env)
+ - `-j`    path to license json file for Spark NLP for Healthcare
+ - `-o`    path to license json file for Spark OCR
+ - `-a`    path to a single license json file for both Spark OCR and Spark NLP
+ - `-s`    specify pyspark version
+ - `-p`    specify port of jupyter notebook
+
+Use the `-i` flag for installing the libraries in a new virtual environment. 
 
-Use the -i flag for installing the libraries in a new virtual environment. 
+You can provide the desired path for virtual env using `-v` flag, otherwise a default location of `./sparknlp_env` will be selected. 
 
-You can provide the desired path for virtual env using -v flag, otherwise a default location of ./sparknlp_env will be selected. 
+The `PATH_TO_LICENSE_JSON_FILE` parameter must be replaced with the path where the license file is available on the local machine. According to the libraries you want to use different flags are available: `-j`, `-o` or `-a`. The license files can be easily downloaded from *My Subscription* section in your [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/) account.
 
-The PATH_TO_LICENSE_JSON_FILE must be replaced to the path where the license file is available on the local machine. According to the libraries you want to use you have different flags: -j, -o, -a. The license files can be easily downloaded from *My Subscription* section in your my.JohnSnowLabs.com account. 
+To start using Jupyter Notebook after the installation of the libraries use the `-r` flag. 
 
-To directly start using Jupyter Notebook after the installation of the libraries user the -r flag. The install script downloads a couple of ready to use example notebooks that you can use to start experimenting with the libraries. 
+The install script downloads a couple of example notebooks that you can use to start experimenting with the libraries. Those will be availabe under `./JohnSnowLabs/example_notebooks` folder. 
 
 
-## Install NLP Libraries via Docker
+## Install via Docker
 
-We have prepared a docker image that contains all the required libraries for installing and running Spark NLP for Healthcare. However, it does not contain the library itself, as it is licensed, and requires installation credentials.
+A docker image that contains all the required libraries for installing and running Spark NLP for Healthcare is also available. However, it does not contain the library itself, as it is licensed, and requires installation credentials.
 
-Make sure you have valid license for Spark NLP for Healthcare, and follow the instructions below:
+Make sure you have a valid license for Spark NLP for Healthcare (in case you do not have one, you can ask for a trial [here](https://www.johnsnowlabs.com/install/) ), and follow the instructions below:
 
 
 ### Instructions
 
-- Run the following commands to download the docker-compose.yml and the sparknlp_keys.txt files on your local machine:
+- Run the following commands to download the `docker-compose.yml` and the `sparknlp_keys.txt` files on your local machine:
 ```bash
 curl -o docker-compose.yaml https://github.com/JohnSnowLabs/spark-nlp-workshop/blob/513a4d682f11abc33b2e26ef8a9d72ad52a7b4f0/jupyter/docker_image_nlp_hc/docker-compose.yaml
 curl -o sparknlp_keys.txt https://raw.githubusercontent.com/JohnSnowLabs/spark-nlp-workshop/master/jupyter/docker_image_nlp_hc/sparknlp_keys.txt
 ```
-- Download your license key in json format from my.johnsnowlabs.com 
-- Populate License keys in sparknlp_keys.txt.
+
+- Download your license key in json format from [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/) 
+- Populate License keys in `sparknlp_keys.txt` file.
 - Run the following command to run the container in detached mode:
+
 ```bash
  docker-compose up -d
  ``` 
-- By default, the jupyter notebook would run at port 8888 - you can access the notebook by typing localhost:8888 in your browser.
+- By default, the jupyter notebook runs on port `8888` - you can access it by typing `localhost:8888` in your browser.
 
 
 ### Troubleshooting
 
 - Make sure docker is installed on your system.
 - If you face any error while importing the lib inside jupyter, make sure all the credentials are correct in the key files and restart the service again.
-- If the default port 8888 is already occupied by another process, please change the mapping.
-- You can change/adjust volume and port mapping in the docker-compose.yml file.
+- If the default port `8888` is already occupied by another process, please change the mapping.
+- You can change/adjust volume and port mapping in the `docker-compose.yml` file.
+- You don't have a license key? Ask for a trial license [here](https://www.johnsnowlabs.com/install/).
 
 ## Install locally on Python
 
@@ -79,7 +86,9 @@ pip install -q spark-nlp-jsl==${version} --extra-index-url https://pypi.johnsnow
 
 `{version}` is the version part of the `{secret.code}` (`{secret.code}.split('-')[0]`) (i.e. `2.6.0`)
 
-The `{secret.code}` is a secret code that is only available to users with valid/trial license. If you did not receive it yet, please contact us at <a href="mailto:[email protected]">[email protected]</a>.
+The `{secret.code}` is a secret code that is only available to users with valid/trial license. 
+
+You can ask for a free trial for Spark NLP for Healthcare [here](https://www.johnsnowlabs.com/install/). Then, you can obtain the secret code by visiting your account on [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/). Read more on how to get a license [here](licensed_install#get-a-spark-nlp-for-healthcare-license).
 
 
 ### Setup AWS-CLI Credentials for licensed pretrained models
@@ -91,22 +100,23 @@ Instructions about how to install AWSCLI are available at:
 
 <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html">Installing the AWS CLI</a>
 
-Make sure you configure your credentials with aws configure following the instructions at:
+Make sure you configure your credentials with AWS configure following the instructions at:
 
 <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the AWS CLI</a>
 
-Please substitute the `ACCESS_KEY` and `SECRET_KEY` with the credentials you have received from your Customer Owner (CO). If you need your credentials contact us at <a href="mailto:info@johnsnowlabs.com">info@johnsnowlabs.com</a>.
+Please substitute the `ACCESS_KEY` and `SECRET_KEY` with the credentials available on your license json file. This is available on your account from [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/). [Read this](licensed_install#get-a-spark-nlp-for-healthcare-license) for more information.
 
 
 ### Start Spark NLP for Healthcare Session from Python
 
-The following will initialize the spark session in case you have run the jupyter notebook directly. If you have started the notebook using
+The following will initialize the spark session in case you have run the Jupyter Notebook directly. If you have started the notebook using
 pyspark this cell is just ignored.
 
 Initializing the spark session takes some seconds (usually less than 1 minute) as the jar from the server needs to be loaded.
 
-The `{secret-code}` is a secret  string you should have received from your Customer Owner (CO). If you have
-not received them, please contact us at <a href="mailto:[email protected]">[email protected]</a>.
+The `{secret.code}` is a secret code that is only available to users with valid/trial license. 
+
+You can ask for a free trial for Spark NLP for Healthcare [here](https://www.johnsnowlabs.com/install/). Then, you can obtain the secret code by visiting your account on [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/). Read more on how to get a license [here](licensed_install#get-a-spark-nlp-for-healthcare-license).
 
 You can either use our convenience function to start your Spark Session that will use standard configuration arguments:
 
@@ -116,6 +126,7 @@ spark = sparknlp_jsl.start("{secret.code}")
 ```
 
 Or use the SparkSession module for more flexibility:
+
 ```python
 from pyspark.sql import SparkSession
 
@@ -157,7 +168,7 @@ spark-submit --packages com.johnsnowlabs.nlp:spark-nlp_2.12:3.2.3 --jars spark-n
 
 ### Use Spark NLP for Healthcare in Spark shell
 
-1.Download the fat jar for spark-nlp-healthcare.
+1.Download the fat jar for Spark NLP for Healthcare
 
 ```bash
 aws s3 cp --region us-east-2 s3://pypi.johnsnowlabs.com/$jsl_secret/spark-nlp-jsl-$jsl_version.jar spark-nlp-jsl-$jsl_version.jar
@@ -179,7 +190,7 @@ spark-shell --packages com.johnsnowlabs.nlp:spark-nlp_2.12:${public-version} --j
 
 ### Use Spark NLP for Healthcare in Sbt project
 
-1.Download the fat jar for spark-nlp-healthcare.
+1.Download the fat jar for Spark NLP for Healthcare.
 ```bash
 aws s3 cp --region us-east-2 s3://pypi.johnsnowlabs.com/$jsl_secret/spark-nlp-jsl-$jsl_version.jar spark-nlp-jsl-$jsl_version.jar
 ```
@@ -399,4 +410,16 @@ spark = start(SECRET)
 ```
 
 As you see, we did not set `.master('local[*]')` explicitly to let YARN manage the cluster.
-Or you can set `.master('yarn')`.
+Or you can set `.master('yarn')`.
+
+
+## Get a Spark NLP for Healthcare license 
+
+You can ask for a free trial for Spark NLP for Healthcare [here](https://www.johnsnowlabs.com/install/). This will automatically create a new account for you on [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/). Login in to your new account and from `My Subscriptions` section, you can download your license key as a json file.
+
+The license json file contains:
+- the secrets for installing the Spark NLP for Healthcare and Spark OCR libraries, 
+- the license key as well as 
+- AWS credentials that you need to access the s3 bucket where the healthcare models and pipelines are published.  
+
+If you have asked for a trial license but you cannot access your account on [my.JohnSnowLabs.com](https://my.johnsnowlabs.com/) and you did not receive the license information via email, please contact us at <a href="mailto:[email protected]">[email protected]</a>.