Skip to content

Commit

Permalink
update README->docs/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hobson Lane committed Nov 13, 2018
1 parent 77e23e7 commit 03238d7
Showing 1 changed file with 41 additions and 4 deletions.
45 changes: 41 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Once you have Git installed, launch a bash terminal.
It will usually be found among your other applications with the name `git-bash`.


### Step 1. Install [Anaconda3 (Python3.6)](https://docs.anaconda.com/anaconda/install/)
### Step 1. Install [Anaconda3](https://docs.anaconda.com/anaconda/install/)

* [Linux](https://repo.anaconda.com/archive/Anaconda3-5.2.0-Linux-x86_64.sh)
* [MacOSX](https://repo.anaconda.com/archive/Anaconda3-5.2.0-MacOSX-x86_64.pkg)
Expand Down Expand Up @@ -93,16 +93,23 @@ Use conda (part of the Anaconda package that you installed in Step 1 above) to c
cd nlpia # make sure you're in the nlpia directory that contains `setup.py`
conda env create -n nlpiaenv -f conda/environment.yml
conda install pip # to get the latest version of pip
source activate nlpiaenv
pip install -e .
```

Whenever you want to be able to import or run any `nlpia` modules, you'll need to activate this conda environment first:

```bash
source activate nlpiaenv
$ source activate nlpiaenv
```

On **Windows** CMD prompt (Anaconda Prompt in Applications) there is no source command so:

```dos
C:\ activate nlpiaenv
```

Make sure you can import nlpia with:
Now you can finally make sure you can import nlpia with:

```bash
python -c "print(import nlpia)"
Expand All @@ -112,6 +119,20 @@ Skip to Step 6 ("Have fun!") if you have successfully created and activated an e

#### Alternative 5.2. `pip`

You can try this first, if you're feeling lucky:

```bash
cd nlpia
pip install --upgrade pip
pip install -e .
```

Or if you don't think you'll be editing any of the source code for nlpia your can just:

```bash
pip install nlpia
```

Linux-based OSes like Ubuntu and OSX come with C++ compilers built-in, so you may be able to install the dependencies using pip instead of `conda`.
But if you're on Windows and you want to install packages, like `python-levenshtein` that need compiled C++ libraries, you'll need a compiler.
Fortunately Microsoft still lets you [download a compiler for free](https://wiki.python.org/moin/WindowsCompilers#Microsoft_Visual_C.2B-.2B-_14.0_standalone:_Visual_C.2B-.2B-_Build_Tools_2015_.28x86.2C_x64.2C_ARM.29), just make sure you follow the links to the Visual Studio "Build Tools" and not the entire Visual Studio package.
Expand Down Expand Up @@ -150,6 +171,22 @@ ls
Help other NLP practicioners by contributing your code and knowledge.
Here are some ideas for a few features others might find handy.

## Using Docker
### 1. Build your image (This process might take few minutes for download jupyter docker image)
- `docker build -t nlpia .`

### 2. Run your image
- `docker run -p 8888:8888 nlpia`
- Copy the `token` obtained from the run log
- Open Browser and use the link `http://localhost:8888/?token=...`

### 3. Play around
- If you want to keep your notebook file or share a folder with the running container then use the command:

`docker run -p 8888:8888 -v ~:/home/jovyan/work nlpia`

- Open new notebook and test your code, and make sure save it inside `work` directory.

#### Feature 1: Glossary Compiler

Skeleton code and APIs that could be added to the https://github.com/totalgood/nlpia/blob/master/src/nlpia/transcoders.py:`transcoders.py` module.
Expand Down Expand Up @@ -248,7 +285,7 @@ If you have pairs of statements or words in two languages, you can build a seque

#### Other Ideas

There are a lot more project ideas mentioned in NLPIA "Appendix E -- Resources". Here's an early draft of [that resource list](https://github.com/totalgood/nlpia/blob/master/src/nlpia/data/book/Appendix%20E%20--%20Resources.asc.md).
There are a lot more project ideas mentioned in the "Resources" section at the end of NLPIA. Here's an early draft of [that resource list](https://github.com/totalgood/nlpia/blob/master/src/nlpia/data/book/Appendix%20E%20--%20Resources.asc.md).



0 comments on commit 03238d7

Please sign in to comment.