Added rendered html pages

Author: Peter Izsak

.gitignore

@@ -13,8 +13,6 @@ generated
 /dist/
 *.hdf5
 *.h5
-#!nlp_architect/server/angular-ui/dist/angular-ui/*.html
-#*.html
 docs-source/_build/**
 !nlp_architect/solutions/set_expansion/ui/templates/*.html
 .vscode

docs/CONTRIBUTING.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Contribution Process &mdash; NLP Architect by Intel® AI Lab 0.4.post2 documentation</title>
+  <title>Contribution Process &mdash; NLP Architect by Intel® AI Lab 0.5 documentation</title>
 
 
 
@@ -25,6 +25,8 @@
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>
+        <script type="text/javascript" src="_static/install.js"></script>
+        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
 
     <script type="text/javascript" src="_static/js/theme.js"></script>
 
@@ -33,8 +35,9 @@
 
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato" type="text/css" />
-  <link rel="stylesheet" href="_static/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/nlp_arch_theme.css" type="text/css" />
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
+  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" /> 
 </head>
@@ -55,7 +58,7 @@
 
 
 
-            <img src="_static/nlp_architect_logo_white.png" class="logo" alt="Logo"/>
+            <img src="_static/logo.png" class="logo" alt="Logo"/>
 
           </a>
 
@@ -81,31 +84,27 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="main.html">Home</a></li>
+<li class="toctree-l1"><a class="reference internal" href="quick_start.html">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
 <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Jupyter Tutorials</a></li>
-<li class="toctree-l1"><a class="reference internal" href="developer_guide.html">Developer Guide</a></li>
-<li class="toctree-l1"><a class="reference internal" href="service.html">REST Server</a></li>
 <li class="toctree-l1"><a class="reference internal" href="model_zoo.html">Model Zoo</a></li>
 </ul>
 <p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="absa.html">Aspect Based Sentiment Analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="chunker.html">Sequence Chunker</a></li>
-<li class="toctree-l1"><a class="reference internal" href="ner_crf.html">Named Entity Recognition</a></li>
+<li class="toctree-l1"><a class="reference internal" href="tagging/sequence_tagging.html">Sequence Tagging</a></li>
+<li class="toctree-l1"><a class="reference internal" href="sentiment.html">Sentiment Analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="bist_parser.html">Dependency Parsing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="intent.html">Intent Extraction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="np_segmentation.html">Noun Phrase Semantic Segmentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="bist_parser.html">BIST Dependency Parser</a></li>
-<li class="toctree-l1"><a class="reference internal" href="word_sense.html">Most Common Word Sense</a></li>
-<li class="toctree-l1"><a class="reference internal" href="np2vec.html">Noun Phrase to Vec</a></li>
-<li class="toctree-l1"><a class="reference internal" href="supervised_sentiment.html">Supervised Sentiment</a></li>
-<li class="toctree-l1"><a class="reference internal" href="reading_comprehension.html">Reading Comprehension</a></li>
-<li class="toctree-l1"><a class="reference internal" href="memn2n.html">End-to-End Memory Networks for Goal Oriented Dialogue</a></li>
-<li class="toctree-l1"><a class="reference internal" href="tcn.html">TCN Language Model</a></li>
-<li class="toctree-l1"><a class="reference internal" href="crosslingual_emb.html">Unsupervised Crosslingual Embeddings</a></li>
-<li class="toctree-l1"><a class="reference internal" href="cross_doc_coref.html">Cross Document Co-Reference</a></li>
-<li class="toctree-l1"><a class="reference internal" href="identifying_semantic_relation.html">Semantic Relation Identification</a></li>
+<li class="toctree-l1"><a class="reference internal" href="lm.html">Language Models</a></li>
+<li class="toctree-l1"><a class="reference internal" href="information_extraction.html">Information Extraction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="transformers.html">Transformers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="archived/additional.html">Additional Models</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Optimized Models</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="quantized_bert.html">Quantized BERT</a></li>
+<li class="toctree-l1"><a class="reference internal" href="transformers_distillation.html">Transformers Distillation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Solutions</span></p>
@@ -114,14 +113,11 @@
 <li class="toctree-l1"><a class="reference internal" href="term_set_expansion.html">Set Expansion</a></li>
 <li class="toctree-l1"><a class="reference internal" href="trend_analysis.html">Trend Analysis</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Pipelines</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="spacy_bist.html">Spacy-BIST Parser</a></li>
-<li class="toctree-l1"><a class="reference internal" href="spacy_np_annotator.html">Spacy-NP Annotator</a></li>
-</ul>
 <p class="caption"><span class="caption-text">For Developers</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="generated_api/nlp_architect_api_index.html">nlp_architect API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="service.html">REST Server</a></li>
+<li class="toctree-l1"><a class="reference internal" href="developer_guide.html">Developer Guide</a></li>
 </ul>
 
 
@@ -187,14 +183,14 @@
   <div class="section" id="contribution-process">
 <h1>Contribution Process<a class="headerlink" href="#contribution-process" title="Permalink to this headline">¶</a></h1>
 <ol class="arabic simple">
-<li><p>File an issue (to track your contribution):</p>
-<ul class="simple">
-<li><p>Create an issue on GitHub:
-<a class="reference external" href="https://github.com/NervanaSystems/nlp-architect/issues">https://github.com/NervanaSystems/nlp-architect/issues</a></p></li>
+<li>File an issue (to track your contribution):<ul>
+<li>Create an issue on GitHub:
+<a class="reference external" href="https://github.com/NervanaSystems/nlp-architect/issues">https://github.com/NervanaSystems/nlp-architect/issues</a></li>
 </ul>
 </li>
-<li><p>Clone and/or update your checked out copy of nlp-architect to ensure you have the
-most recent commits from the master branch:</p></li>
+<li>Fork NLP Architect and/or update your checked out copy of
+nlp-architect to ensure you have the
+most recent commits from the master branch, for example:</li>
 </ol>
 <blockquote>
 <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/NervanaSystems/nlp-architect.git
@@ -206,43 +202,42 @@ <h1>Contribution Process<a class="headerlink" href="#contribution-process" title
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="3">
-<li><p>Create a new feature branch for your work and switch to it.  Give it a
-meaningful name related to the task(s) at hand:</p></li>
+<li>Create a new feature branch for your work and switch to it.  Give it a
+meaningful name related to the task(s) at hand:</li>
 </ol>
 <blockquote>
 <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git checkout -b my_new_feature_branch
 </pre></div>
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="4">
-<li><p>Ideally you’d start by creating one or more unit tests with the
+<li>Ideally you’d start by creating one or more unit tests with the
 functionality you expect your new feature to perform.  These should reside
 under the appropriate tests subdirectory of whatever you are changing.
 Then hack away at the code until you feel your feature is complete.  Once
-satisfied, run the code through the following checks:</p></li>
+satisfied, run the code through the following checks:</li>
 </ol>
 <blockquote>
-<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>nlp_architect <span class="nb">test</span>   <span class="c1"># ensure all are OK</span>
-nlp_architect style  <span class="c1"># ensure there are no style related issues</span>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./scripts/run_tests.sh    <span class="c1"># ensure all are OK</span>
+./scripts/check_style.sh  <span class="c1"># ensure there are no style related issues</span>
 </pre></div>
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="5">
-<li><p>If necessary you may want to update and/or rebuild the documentation.
+<li>If necessary you may want to update and/or rebuild the documentation.
 This all exists under docs-source/source and is in
-<a class="reference external" href="http://sphinx-doc.org/rest.html">Sphinx reStructuredText format</a>:</p></li>
+<a class="reference external" href="http://sphinx-doc.org/rest.html">Sphinx reStructuredText format</a>:</li>
 </ol>
 <blockquote>
-<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> scripts/
-sh create_docs.sh   <span class="c1"># builds the doc and starts a local server directly</span>
+<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./scripts/create_docs.sh   <span class="c1"># builds the doc and starts a local server directly</span>
 </pre></div>
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="6">
-<li><p>Commit your changes and push your feature branch to your GitHub fork.  Be
+<li>Commit your changes and push your feature branch to your GitHub fork.  Be
 sure to add a descriptive message and reference the GitHub issue associated
 with your task (ex. #1).  You will also want to rebase your commits down to
-a single sensible commit to make things clean for the merge process:</p></li>
+a single sensible commit to make things clean for the merge process:</li>
 </ol>
 <blockquote>
 <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git add my_updated_files
@@ -252,31 +247,15 @@ <h1>Contribution Process<a class="headerlink" href="#contribution-process" title
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="7">
-<li><p>Create a new pull request to get your feature branch merged into master for
-others to use.  You’ll first need to ensure your feature branch contains the
-latest changes from master.  Furthermore, internal devs will need to assign
-the request to someone else for a code review.  You must also ensure there
-are no errors when run through the items defined in step 4.</p></li>
-</ol>
-<blockquote>
-<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># (external contribs): make a new pull request:</span>
-https://github.com/NervanaSystems/nlp-architect/pulls
-
-<span class="c1"># merge latest master changes into your feature branch</span>
-git fetch origin
-git checkout master
-git pull origin master
-git checkout my_new_feature_branch
-git merge master  <span class="c1"># you may need to manually resolve any merge conflicts</span>
-</pre></div>
-</div>
-</div></blockquote>
-<ol class="arabic simple" start="8">
-<li><p>If there are issues you can continue to push commits to your feature branch
+<li>Create a new <a class="reference external" href="https://github.com/NervanaSystems/nlp-architect/pulls">pull request</a>
+to get your feature branch merged into master for others to use.
+You’ll first need to ensure your feature branch contains the latest changes from
+master.</li>
+<li>If there are issues you can continue to push commits to your feature branch
 by following step 6.  They will automatically be added to this same merge
-request.</p></li>
-<li><p>Once your change has been successfully merged, you can remove the source
-branch and ensure your local copy is up to date:</p></li>
+request.</li>
+<li>Once your change has been successfully merged, you can remove the source
+branch and ensure your local copy is up to date:</li>
 </ol>
 <blockquote>
 <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git fetch origin
@@ -288,7 +267,7 @@ <h1>Contribution Process<a class="headerlink" href="#contribution-process" title
 </div>
 </div></blockquote>
 <ol class="arabic simple" start="10">
-<li><p>Give yourself a high five for a job well done!</p></li>
+<li>Give yourself a high five for a job well done!</li>
 </ol>
 </div>