diff --git a/SETUP.md b/SETUP.md index 5894472..3a9dd6a 100755 --- a/SETUP.md +++ b/SETUP.md @@ -87,25 +87,32 @@ We can register our created conda environment to appear as a kernel in the Jupyt If you are using the DSVM, you can [connect to JupyterHub](https://docs.microsoft.com/en-us/azure/machine-learning/data-science-virtual-machine/dsvm-ubuntu-intro#jupyterhub-and-jupyterlab) by browsing to `https://your-vm-ip:8000`. If you are prompted to enter user name and password, enter the user name and password that you use to log in to your virtual machine. -## Install Utils via PIP +## Installing `utils_nlp` via PIP
- The utils_nlp module of this repositiory can be installed as a python package. Click here to expand and see the details + The utils_nlp module of this repositiory needs to be installed as a python package in order to be used by the examples. Click to expand and see the details -

-A [setup.py](setup.py) file is provied in order to simplify the installation of this utilities in this repo from the main directory. +

+A setup.py file is provied in order to simplify the installation of this utilities in this repo from the main directory. + +To install, please run the command below - pip install -e . + python setup.py install -It is also possible to install directly from Github. +It is also possible to install directly from Github, which is the best way to utilize the `utils_nlp` package in external projects. - pip install -e git+git@github.com:microsoft/nlp.git@master#egg=utils_nlp + pip install -e git+git@github.com:microsoft/nlp.git@master#egg=utils_nlp + +Either command, from above, makes `utils_nlp` available in your conda virtual environment. You can verify it was properly installed by running: + + pip list + **NOTE** - The pip installation does not install any of the necessary package dependencies, it is expected that conda will be used as shown above to setup the environment for the utilities being used.

-## Versioning of utils_nlp in this repository +## Versioning of `utils_nlp` in this repository The details of the versioning info can be found at [VERSIONING.md](VERSIONING.md) diff --git a/utils_nlp/azureml/__init__.py b/utils_nlp/azureml/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/utils_nlp/eval/__init__.py b/utils_nlp/eval/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/utils_nlp/interpreter/__init__.py b/utils_nlp/interpreter/__init__.py new file mode 100644 index 0000000..e69de29