Rename CLI commands (#123)

* move server module out from nlp_architect
* update docs

Author: Peter Izsak

README.md

@@ -54,7 +54,6 @@ Features:
   * [Dynet]
 
 * Essential utilities for working with NLP models - Text/String pre-processing, IO, data-manipulation, metrics, embeddings.
-* Plug-able REST API server to serve models via REST API
 
 ## Installing NLP Architect
 
@@ -129,7 +128,6 @@ The main design guidelines are:
 * Generic dataset loaders, textual data processing utilities, and miscellaneous utilities that support NLP model development (loaders, text processors, io, metrics, etc.)
 * Procedures for defining processes for training, inference, optimization or any kind of elaborate script.
 * Pythonic API for using models for inference
-* REST API servers with ability to serve trained models via HTTP
 * Extensive model documentation and tutorials
 
 ### Note

docs-source/source/code_docs/service.rst

@@ -17,8 +17,6 @@
 Service class documentation
 ###########################
 
-.. autoclass:: nlp_architect.server.service.Service
-
 .. autoclass:: nlp_architect.common.core_nlp_doc.CoreNLPDoc
 
 .. autoclass:: nlp_architect.common.high_level_doc.HighLevelDoc

docs-source/source/generated_api/nlp_architect_api_index.rst

@@ -12,6 +12,5 @@
     nlp_architect.nn
     nlp_architect.pipelines
     nlp_architect.procedures
-    nlp_architect.server
     nlp_architect.solutions
     nlp_architect.utils

docs-source/source/index.rst

@@ -73,7 +73,6 @@
    :caption: For Developers
 
    nlp_architect API <generated_api/nlp_architect_api_index.rst>
-   REST Server <service.rst>
    developer_guide.rst
 
 .. _https://github.com/NervanaSystems/nlp-architect: https://github.com/NervanaSystems/nlp-architect

docs-source/source/main.rst

@@ -49,7 +49,6 @@ Features:
   * Dynet
 
 * Essential utilities for working with NLP models - Text/String pre-processing, IO, data-manipulation, metrics, embeddings.
-* Plug-able REST API server to serve models via REST API
 
 
 Library design philosophy
@@ -66,7 +65,6 @@ The main design guidelines are:
 * Generic dataset loaders, textual data processing utilities, and miscellaneous utilities that support NLP model development (loaders, text processors, io, metrics, etc.)
 * ``Procedures`` for defining processes for training, inference, optimization or any kind of elaborate script.
 * Pythonic API for using models for inference
-* REST API servers with ability to serve trained models via HTTP
 * Extensive model documentation and tutorials
 
 Disclaimer

docs-source/source/quantized_bert.rst

@@ -94,7 +94,7 @@ To train Quantized BERT use the following code snippet:
 
 .. code-block:: bash
 
-    nlp_architect train transformer_glue \
+    nlp-train transformer_glue \
         --task_name mrpc \
         --model_name_or_path bert-base-uncased \
         --model_type quant_bert \
@@ -115,7 +115,7 @@ following code snippet:
 
 .. code-block:: bash
 
-    nlp_architect run transformer_glue \
+    nlp-inference transformer_glue \
         --model_path /tmp/mrpc-8bit \
         --task_name mrpc \
         --model_type quant_bert \

docs-source/source/quick_start.rst

@@ -67,8 +67,6 @@ NLP Architect has the following packages:
 +---------------------------+-------------------------------------------------------+
 | `nlp_architect.procedures`| Procedure scripts                                     |
 +---------------------------+-------------------------------------------------------+
-| `nlp_architect.server`    | API Server and demos UI                               |
-+---------------------------+-------------------------------------------------------+
 | `nlp_architect.solutions` | Solution applications                                 |
 +---------------------------+-------------------------------------------------------+
 | `nlp_architect.utils`     | Misc. I/O, metric, pre-processing and text utilities  |
@@ -85,16 +83,11 @@ NLP Architect comes with a CLI application that helps users run procedures and p
     The CLI is in development and some functionality is not complete
     and will be added in future versions
 
-The list of possible options can be obtained by ``nlp_architect -h``:
-
-``nlp_architect`` commands:
+NLP Architect commands:
 
 .. code-block:: text
 
-    train        Train a model from the library
-    run          Run a model from the library
-    process      Run a data processor from the library
-    solution     Run a solution process from the library
-    serve        Server a trained model using REST service
+    nlp-train       Train a model from the library
+    nlp-inference   Run a model from the library
 
-Use ``nlp_architect <command> -h`` for per command usage instructions.
+Use ``nlp-train/inference -h`` for per command usage instructions.

docs-source/source/service.rst

@@ -32,20 +32,28 @@ Currently we provide 4 services:
 
 The server has two main components:
 
-- :py:class:`Service <nlp_architect.server.service.Service>` which is a representation of each model's API.
-- ``nlp_architect.server.serve`` module which is a `hug <http://www.hug.rest/>`_ application which handles processing of HTTP requests and initiating calls to the desired model.
+- :py:class:`Service <server.service.Service>` which is a representation of each model's API.
+- ``server.serve`` module which is a `hug <http://www.hug.rest/>`_ application which handles processing of HTTP requests and initiating calls to the desired model.
 
 The server supports extending with new services using provided API classes, see `Annotation Structure Types - Server Responses`_ for more details.
 
 Running NLP Architect Server
 ============================
+Install requirements
+--------------------
+The server requires extra python packages:
+
+.. code:: bash
+
+    pip install -r server/requirements.txt
+
 Starting the server
 -------------------
 To run the server run the following command:
 
 .. code:: bash
 
-    nlp_architect server -p 8080
+    hug -f serve.py -p 8080
 
 The server will run locally on port 8080 and can be queried on ``/inference`` directive.
 
@@ -179,7 +187,7 @@ Adding new services
 ===================
 Adding a new service to the server
 ----------------------------------
-All the services are declared in a ``JSON`` file found at ``nlp_architect/server/services.json``.
+All the services are declared in a ``JSON`` file found at ``server/services.json``.
 
 In order to add a new service to the server you need to go over 3 steps: