twNLP-app/README.md

# **ckip-cwn-app**
中文很適合拿來探索自然語言處理管線的標記語言。這個探索過程也可反應生成語言架構多年來牽制語言理論，以及它對於自然語言處理與理解的想像影響。

## **Documentation**
### 1. Installation

1. Python version
   * `python == 3.7.5`

2. Clone repository

    ```bash
    git clone git@github.com:lopentu/nlp_web.git
    ```

3. Install Requirement
    ```bash
    cd nlp_web/assignments/twNLP-app && pip install -r requirements.txt      
    ```


### 2. Start the app
There are two main ways to run the app:

- run with Python 

  First make sure you are in the `twNLP-app` folder, and then simply run:

  ```bash 
  streamlit run src/app.py
  ```

- run with Docker
  
  Install Docker, and user the following command to run:
  
  ```bash
  docker-compose up
  ```

  Then acces `http://localhost` in the browser.


## Contact
If you have any suggestion or question, please do not hesitate to email us at shukai@gmail.com or r07142010@g.ntu.edu.tw