Added content for exporting visual NER project ad updated few other s…

…ections (#13042) * Added content for exporting visual NER project and updated few other sections * Reorg.of the export page Co-authored-by: diatrambitas <JSL.Git2018>
JohnSnowLabs · Nov 7, 2022 · 06e649f · 06e649f
1 parent d01a46c
commit 06e649f
Show file tree

Hide file tree

Showing 8 changed files with 1,169 additions and 93 deletions.
diff --git a/docs/assets/images/annotation_lab/4.1.0/export_visual_ner_project.gif b/docs/assets/images/annotation_lab/4.1.0/export_visual_ner_project.gif
diff --git a/docs/assets/images/annotation_lab/4.1.0/train_and_active_learning.png b/docs/assets/images/annotation_lab/4.1.0/train_and_active_learning.png
diff --git a/docs/assets/images/annotation_lab/4.1.0/train_license.png b/docs/assets/images/annotation_lab/4.1.0/train_license.png
diff --git a/docs/assets/images/annotation_lab/4.1.0/train_model_deployment.png b/docs/assets/images/annotation_lab/4.1.0/train_model_deployment.png
diff --git a/docs/en/alab/export.md b/docs/en/alab/export.md
diff --git a/docs/en/alab/install.md b/docs/en/alab/install.md
@@ -6,14 +6,26 @@ seotitle: Annotation Lab | John Snow Labs
 title: Installation
 permalink: /docs/en/alab/install
 key: docs-training
-modify_date: "2021-09-29"
+modify_date: "2022-11-06"
 use_language_switcher: "Python-Scala"
 show_nav: true
 sidebar:
-    nav: annotation-lab
+  nav: annotation-lab
 ---
 
-## Deploy on a dedicated server
+<style>
+bl {
+  font-weight: 400;
+}
+th {
+  width: 200px;
+  text-align: left;
+  background-color: #f7f7f7;
+  vertical-align: "top";
+}
+</style>
+
+## Dedicated Server
 
 Install Annotation Lab on a dedicated server to reduce the likelihood of conflicts or unexpected behavior.
 
@@ -22,108 +34,151 @@ Install Annotation Lab on a dedicated server to reduce the likelihood of conflic
 To install Annotation Lab run the following command:
 
 ```bash
-wget https://setup.johnsnowlabs.com/annotationlab/install.sh -O - | sudo bash -s VERSION
+wget https://setup.johnsnowlabs.com/annotationlab/install.sh -O - | sudo bash -s $VERSION
 ```
 
+Replace `$VERSION` in the above one liners with the version you want to install.
+
 For installing the latest available version of the Annotation Lab use:
 
 ```bash
 wget https://setup.johnsnowlabs.com/annotationlab/install.sh -O - | sudo bash -s --
 ```
 
-To upgrade your Annotation Lab installation to a newer version, run the following command on a terminal:
+<br />
+
+### Upgrade
 
-### Upgrade 
+To upgrade your Annotation Lab installation to a newer version, run the following command on a terminal:
 
 ```bash
-wget https://setup.johnsnowlabs.com/annotationlab/upgrade.sh -O - | sudo bash -s VERSION
+wget https://setup.johnsnowlabs.com/annotationlab/upgrade.sh -O - | sudo bash -s $VERSION
 ```
-Replace VERSION within the above one liners with the version you want to install.  
+
+Replace `$VERSION` in the above one liners with the version you want to upgrade to.
 
 For upgrading to the latest version of the Annotation Lab, use:
 
 ```bash
 wget https://setup.johnsnowlabs.com/annotationlab/upgrade.sh -O - | sudo bash -s --
 ```
 
-> **NOTE:**  The install/upgrade script displays the login credentials for the admin user on the terminal.
+> **NOTE:** The install/upgrade script displays the login credentials for the _admin_ user on the terminal.
 
-
-After running the install/upgrade script the Annotation Lab is available at http://INSTANCE_IP  or https://INSTANCE_IP 
+After running the install/upgrade script, the Annotation Lab is available at http://INSTANCE_IP or https://INSTANCE_IP
 
 <img class="image image--xl image__shadow" src="/assets/images/annotation_lab/4.1.0/loginScreenALAB.png" style="width:100%;"/>
 
-We have an aesthetically pleasing Login Page with a section highlighting the key features of Annotation Lab. Sign-In page highlights main features of Annotation Lab with animated GIFs.
+We have an aesthetically pleasing Sign-In Page with a section highlighting the key features of Annotation Lab using animated GIFs.
 
-## Deploy on the AWS Marketplace
+## AWS Marketplace
 
-Visit the [product page on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-nsww5rdpvou4w?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and follow the instructions on the video below to subscribe and deploy. 
+Visit the [product page on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-nsww5rdpvou4w?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and follow the instructions on the video below to subscribe and deploy.
 
 <div class="cell cell--12 cell--lg-6 cell--sm-12"><div class="video-item">{%- include extensions/youtube.html id='ebaewU4BcQA' -%}<div class="video-descr">Deploy Annotation Lab via AWS Marketplace</div></div></div>
 
-## Deploy on the Azure Marketplace
+## Azure Marketplace
 
-Visit the [product page on Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/johnsnowlabsinc1646051154808.annotation_lab?tab=Overview) and follow the instructions on the video below to subscribe and deploy. 
+Visit the [product page on Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/johnsnowlabsinc1646051154808.annotation_lab?tab=Overview) and follow the instructions on the video below to subscribe and deploy.
 
 <div class="cell cell--12 cell--lg-6 cell--sm-12"><div class="video-item">{%- include extensions/youtube.html id='e6aB3z5tB0k' -%}<div class="video-descr">Deploy Annotation Lab via Azure Marketplace</div></div></div>
 
-## Deploy on AirGap environment 
+## AirGap Environment
+
+### Get Artifact
 
-### Get artifact
+Run the following command on a terminal to fetch the compressed artifact (_tarball_) of the Annotation Lab.
 
 ```bash
-wget https://s3.amazonaws.com/auxdata.johnsnowlabs.com/annotationlab/annotationlab-VERSION.tar.gz
+wget https://s3.amazonaws.com/auxdata.johnsnowlabs.com/annotationlab/annotationlab-$VERSION.tar.gz
 ```
-replace VERSION with the version you want to download and install. 
 
-### Fresh installation
+Extract the tarball and the change directory to the extracted folder (_artifacts_):
+
+```bash
+tar -xzf annotationlab-$VERSION.tar.gz
+cd artifacts
+```
+
+Replace `$VERSION` with the version you want to download and install.
+
+<br />
+
+### Fresh Install
+
+Run the installer script `annotationlab-installer.sh` with `sudo` privileges.
 
 ```bash
 $ sudo su
 $ ./annotationlab-installer.sh
 ```
-### Upgrade version
+
+<br />
+
+### Upgrade
+
+Run the upgrade script `annotationlab-updater.sh` with `sudo` privileges.
 
 ```bash
 $ sudo su
 $ ./annotationlab-updater.sh
 ```
+
+<br />
+
 ### Work over proxy
 
-- Custom CA certificate
+**Custom CA certificate**
 
 You can provide a custom CA certificate chain to be included into the deployment. To do it add `--set-file custom_cacert=./cachain.pem` options to `helm install/upgrade` command inside `annotationlab-installer.sh` and `annotationlab-updater.sh` files.
-cachain.pem must include a certificate in the following format:
+
+_cachain.pem_ must include a certificate in the following format:
+
 ```bash
 -----BEGIN CERTIFICATE-----
 ....
 -----END CERTIFICATE-----
 ```
 
-- Proxy env variables
+<br />
 
-You can provide a proxy to use for external communications. To do that add 
+**Proxy env variables**
 
-    `--set proxy.http=[protocol://]<host>[:port]`, 
-    `--set proxy.https=[protocol://]<host>[:port]`, 
-    `--set proxy.no=<comma-separated list of hosts/domains>` 
+You can provide a proxy to use for external communications. To do that add
 
-commands inside `annotationlab-installer.sh` and `annotationlab-updater.sh` files.
+    `--set proxy.http=[protocol://]<host>[:port]`,
+    `--set proxy.https=[protocol://]<host>[:port]`,
+    `--set proxy.no=<comma-separated list of hosts/domains>`
 
+commands inside `annotationlab-installer.sh` and `annotationlab-updater.sh` files.
 
 ## Recommended Configurations
 
-**System requirements**. You can install Annotation Lab on a Ubuntu 20+ machine.
-
-**Port requirements**. Annotation Lab expects ports 443 and 80 to be open by default. 
-
-**Server requirements**. The minimal required configuration is **32GB RAM, 8 Core CPU, 512 SSD**. 
-The ideal configuration in case model training and preannotations are required on a large number of tasks is **64 GiB, 16 Core CPU, 2TB HDD, 512 SSD**. 
-
-**Web browser support**. Annotation Lab is tested with the latest version of Google Chrome and is expected to work in the latest versions of:
-
-•   Google Chrome
-
-•   Apple Safari
-
-•   Mozilla Firefox
+<table>
+  <tr>
+    <th>System requirements</th>
+    <td>You can install Annotation Lab on a Ubuntu 20+ machine.</td>
+  </tr>
+  <tr>
+    <th>Port requirements</th>
+    <td>Annotation Lab expects ports <bl>443</bl> and <bl>80</bl> to be open by default.</td>
+  </tr>
+  <tr>
+    <th>Server requirements</th>
+    <td>The minimal required configuration is <bl>32GB RAM, 8 Core CPU, 512 SSD</bl>.<br /><br />
+
+    The ideal configuration in case model training and preannotations are required on a large number of tasks is <bl>64 GiB, 16 Core CPU, 2TB HDD, 512 SSD</bl>.
+    </td>
+
+  </tr>
+  <tr>
+    <th>Web browser support</th>
+    <td>Annotation Lab is tested with the latest version of Google Chrome and is expected to work in the latest versions of:
+      <ul>
+      <li>Google Chrome</li>
+      <li>Apple Safari</li>
+      <li>Mozilla Firefox</li>
+      </ul>
+    </td>
+  </tr>
+</table>
diff --git a/docs/en/alab/project_dashboard.md b/docs/en/alab/project_dashboard.md
@@ -3,29 +3,29 @@ layout: docs
 comment: no
 header: true
 seotitle: Annotation Lab | John Snow Labs
-title: Dashboard 
+title: Dashboard
 permalink: /docs/en/alab/project_dashboard
 key: docs-training
-modify_date: "2022-11-01"
+modify_date: "2022-11-07"
 use_language_switcher: "Python-Scala"
 show_nav: true
 sidebar:
-    nav: annotation-lab
+  nav: annotation-lab
 ---
 
-When logging in to the Annotation Lab, the user sees the main `Projects Dashboard`. For each project, details like description, task counts, assigned groups, team members, etc. are available on the main dashboard so users can quickly identify the projects they need to work on, without navigating to the `Project Details` page. 
-Projects can be filtered based on the creator: **My Projects**, created by the current user or **Shared With Me**, created by other users and shared with the current one. 
+When logging in to the Annotation Lab, the user sees the main `Projects Dashboard`. For each project, details like description, task counts, assigned groups, team members, etc. are available on the main dashboard so users can quickly identify the projects they need to work on, without navigating to the `Project Details` page.
+
+Projects can be filtered based on the creator: **My Projects**, created by the current user or **Shared With Me**, created by other users and shared with the current one.
 **All Projects** option combines the list of the projects created by the current user and those shared by others.
 
 <img class="image image--xl image__shadow" src="/assets/images/annotation_lab/4.1.0/dashboardShared.png" style="width:100%;"/>
 
-
-The list of projects can be sorted according to the name of the project. Also, projects can be sorted in ascending or descending order according to the creation date. 
+The list of projects can be sorted according to the name of the project. Also, projects can be sorted in ascending or descending order according to the creation date.
 
 <img class="image image--xl image__shadow" src="/assets/images/annotation_lab/4.1.0/dashboardSort.png" style="width:100%;"/>
 
 The filters associated with the `Projects Dashboard` are clear, simple, and precise to make the users more productive and efficient while working with a large number of projects.
 
 ![DashboardFilterGIF](https://user-images.githubusercontent.com/46840490/193030380-df251a49-07fa-48a6-85b0-ce342c1fcb65.gif)
 
-Searching features are also available and help users identify projects based on their name. 
+Searching features are also available and help users identify projects based on their name.