Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/santteegt/stat-nlp-cw

stat-nlp private fork for Courseworks
https://github.com/santteegt/stat-nlp-cw

deep-learning moro natural-language-processing scala ucl wolfe

Last synced: about 19 hours ago
JSON representation

stat-nlp private fork for Courseworks

Awesome Lists containing this project

README

        

# stat-nlp-book

### Important Note

This project was created as a private fork from the original version of the [project book](https://github.com/uclmr/stat-nlp-book) with the aim to complete the coursework assignments of the COMPM083: Statistical Natural Language Processing module.

### Live Online Version

We are running a [live online version](http://stat-nlp-book.wolfe.ml:9000/template/statnlpbook/04_compgi19/02_overview) of the book.
Due to security reasons the content is not editable. If you want to play with the code and execute it you need to
install the book locally, as described below.

### Setup and run the book

Before running any of the following comands, make sure you have [all the prerequisites installed](https://github.com/uclmr/stat-nlp-book/wiki/Installation-of-prerequisites).

After installing prerequisites, install the following libraries to a local repository by running the following:

git clone https://github.com/sameersingh/scalaplot.git; cd scalaplot
mvn clean install -Dgpg.skip=true; cd ..
git clone https://github.com/sameersingh/htmlgen.git; cd htmlgen
mvn clean install -Dgpg.skip=true; cd ..

Clone the repository (1),
Initialize sub-modules (wolfe & moro) (2), compile the project (3) and compile wolfe, and publish it to your local ivy repository (4), setup the project specific configuration file (5) and run moro (6).

1. `git clone https://github.com/uclmr/stat-nlp-book.git; cd stat-nlp-book`
2. `git submodule update --init --recursive`
3. `sbt compile`
4. `cd wolfe; sbt compile; sbt publish-local; cd ..`
5. `cp moro/conf/application-statnlpbook.conf moro/conf/application.conf`
6. `cd moro; git checkout master; sbt run`
7. `ln -s $PWD/src/main/moro/figures $PWD/moro/public/figures`

Remarks:
- ignore `[error] (wolfe-examples/compile:doc) Scaladoc generation failed` when executing step 4
- step 4 - You may have to delete the wolfe directory in the ivy cache to make sure you get the newest version.
- step 6 - You might me bugged by your firewall here. Set it to allow the application. This step might take some time depending on your computer performance. Do not panic over warning messages :)
- for windows users, split the commands at the semi-colon (;) and run them on separate lines. The cmd command equivalent for *cp* is *copy*.

### Download Data
To download the OHHLA files, execute the following in your stat-nlp-book folder (NOT in the script folder)

./scripts/download_ohhla.sh j_live
./scripts/download_ohhla_txt.sh YFA_roots.html
./scripts/download_ohhla_txt.sh YFA_rakim.html

Remarks:
- the scripts make use of the *wget* command for downloading files. If you cannot run the scripts, open them with a text editor and run the command on the command line.
- for windows users, you first need to instal *wget* for your windows command line.

## Browse the Book
Everytime you want to run the book, you have to go to the `stat-nlp-book/moro` directory and call `sbt run`.

Once you have the book running (step 6), proceed to the COMPGI19 entry point [here](http://localhost:9000/template/statnlpbook/04_compgi19/02_overview).

## Live editing in IntelliJ

You can write code in IntelliJ and access it from moro after you compile it (either through IntelliJ or sbt)

To import the stat-nlp-book project to IntelliJ:

1. Open IntelliJ
2. Select *Import Project* and select the stat-nlp-book directory
3. Select *Import project from external module* and SBT under it, and click on OK.
4. In the next window select auto-import and continue with importing.

## Contact your TAs

If you have a question that is not specific to you but could be interesting for other students as well, please post it in the [discussion forum](https://moodle.ucl.ac.uk/mod/forum/view.php?id=1402119). Otherwise, contact us directly.

- [George Spithourakis](mailto:[email protected])
- [Johannes Welbl](mailto:[email protected])
- [Tim Rocktäschel](mailto:[email protected])
- [Matko Bošnjak](mailto:[email protected])

When contacting us, please send a single e-mail to all four of us so we can coordinate the response.