zaidmehdi commited on
Commit
ce6d0cc
1 Parent(s): d93cfa5

update readme

Browse files
Files changed (1) hide show
  1. README.md +5 -16
README.md CHANGED
@@ -2,10 +2,8 @@
2
  This project is a classifier of arabic dialects at a country level:
3
  Given some arabic text, the goal is to predict the country of the text's dialect.
4
 
5
- You can use the "/classify" endpoint through a POST request with a json input of the form: '{"text": "Your arabic text"}'
6
- ```
7
- curl -X POST -H "Content-Type: application/json" -d '{"text": "Your arabic text"}' http://localhost:8080/classify
8
- ```
9
 
10
  ## Run the app locally with Docker:
11
  1. Clone the repository with Git:
@@ -14,23 +12,14 @@ git clone https://github.com/zaidmehdi/arabic-dialect-classifier.git
14
  ```
15
  2. Build the Docker image:
16
  ```
17
- docker build -t adc .
18
  ```
19
  3. Run the Docker Container:
20
  ```
21
- docker run -p 8080:80 adc
22
  ```
23
 
24
- Now you can try sending a POST request:
25
- ```
26
- curl -X POST -H "Content-Type: application/json" -d '{"text": "Your Arabic text"}' http://localhost:8080/classify
27
- ```
28
- The response should be a json with the following fields:
29
- ```
30
- {
31
- "class": "country_name"
32
- }
33
- ```
34
 
35
  ## How I built this project:
36
  The data used to train the classifier comes from the NADI 2021 dataset for Arabic Dialect Identification [(Abdul-Mageed et al., 2021)](#cite-mageed-2021).
 
2
  This project is a classifier of arabic dialects at a country level:
3
  Given some arabic text, the goal is to predict the country of the text's dialect.
4
 
5
+ App Demo:
6
+ **link**
 
 
7
 
8
  ## Run the app locally with Docker:
9
  1. Clone the repository with Git:
 
12
  ```
13
  2. Build the Docker image:
14
  ```
15
+ sudo docker build -t adc .
16
  ```
17
  3. Run the Docker Container:
18
  ```
19
+ sudo docker run -p 8080:80 adc
20
  ```
21
 
22
+ Now you can go to the port
 
 
 
 
 
 
 
 
 
23
 
24
  ## How I built this project:
25
  The data used to train the classifier comes from the NADI 2021 dataset for Arabic Dialect Identification [(Abdul-Mageed et al., 2021)](#cite-mageed-2021).