IsmatS commited on
Commit
b2f0cde
·
1 Parent(s): 7a46847
Files changed (1) hide show
  1. README.md +12 -4
README.md CHANGED
@@ -37,6 +37,8 @@ You can try out the deployed model here: [Named Entity Recognition Demo](https:/
37
 
38
  Both models were fine-tuned on a premium A100 GPU in Google Colab for optimized training performance.
39
 
 
 
40
  ## Model Performance Metrics
41
 
42
  ### mBERT Model
@@ -67,17 +69,23 @@ Both models were fine-tuned on a premium A100 GPU in Google Colab for optimized
67
  cd named-entity-recognition
68
  ```
69
 
70
- 2. **Install dependencies**:
 
 
 
 
 
 
71
  ```bash
72
  pip install -r requirements.txt
73
  ```
74
 
75
- 3. **Run the FastAPI app**:
76
  ```bash
77
  uvicorn main:app --host 0.0.0.0 --port 8080
78
  ```
79
 
80
- 4. **Deploy on Fly.io**:
81
  Use the following steps to deploy the app on Fly.io.
82
 
83
  ## Fly.io Deployment
@@ -130,4 +138,4 @@ Access your deployed app at the Fly.io-provided URL (e.g., `https://your-app-nam
130
 
131
  Access the web interface through the Fly.io URL or `http://localhost:8080` (if running locally) to test the NER model and view recognized entities.
132
 
133
- This application leverages both mBERT and XLM-RoBERTa models fine-tuned on Azerbaijani language data for high-accuracy named entity recognition.
 
37
 
38
  Both models were fine-tuned on a premium A100 GPU in Google Colab for optimized training performance.
39
 
40
+ **Note**: Due to its superior performance, the XLM-RoBERTa model was selected for deployment.
41
+
42
  ## Model Performance Metrics
43
 
44
  ### mBERT Model
 
69
  cd named-entity-recognition
70
  ```
71
 
72
+ 2. **Create and activate a virtual environment**:
73
+ ```bash
74
+ python3 -m venv .venv
75
+ source .venv/bin/activate # On Windows use: .venv\Scripts\activate
76
+ ```
77
+
78
+ 3. **Install dependencies**:
79
  ```bash
80
  pip install -r requirements.txt
81
  ```
82
 
83
+ 4. **Run the FastAPI app**:
84
  ```bash
85
  uvicorn main:app --host 0.0.0.0 --port 8080
86
  ```
87
 
88
+ 5. **Deploy on Fly.io**:
89
  Use the following steps to deploy the app on Fly.io.
90
 
91
  ## Fly.io Deployment
 
138
 
139
  Access the web interface through the Fly.io URL or `http://localhost:8080` (if running locally) to test the NER model and view recognized entities.
140
 
141
+ This application leverages both mBERT and XLM-RoBERTa models fine-tuned on Azerbaijani language data for high-accuracy named entity recognition.