Merge pull request #341 from microsoft/emawa/docs/update-packaging-instruction

Update `utils_nlp` packaging instructions
This commit is contained in:
Said Bleik 2019-08-22 09:29:58 -04:00 коммит произвёл GitHub
Родитель c04eccc9b8 bb638daf58
Коммит b78812c67c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 15 добавлений и 8 удалений

Просмотреть файл

@ -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
<details>
<summary>The utils_nlp module of this repositiory can be installed as a python package. <strong><em>Click here to expand and see the details</em></strong>
<summary>The utils_nlp module of this repositiory needs to be installed as a python package in order to be used by the examples. <strong><em>Click to expand and see the details</em></strong>
</summary>
<p>
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.
pip install -e .
To install, please run the command below
It is also possible to install directly from Github.
python setup.py install
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
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.
</p>
</details>
## 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)

Просмотреть файл

Просмотреть файл

Просмотреть файл