Update README.md
Browse files
README.md
CHANGED
|
@@ -13,20 +13,6 @@ This repository contains code for a Nepali Sentiment Analysis model. The model i
|
|
| 13 |
|
| 14 |
## Dataset
|
| 15 |
|
| 16 |
-
The dataset used for training this model is sourced from [Shushant/NepaliSentiment](https://huggingface.co/datasets/Shushant/NepaliSentiment) on the Hugging Face Datasets Hub. The dataset consists of labeled Nepali text samples with corresponding sentiment labels.
|
| 17 |
-
|
| 18 |
-
## Model Architecture
|
| 19 |
-
|
| 20 |
-
The model architecture used in this repository is based on the BERT (Bidirectional Encoder Representations from Transformers) model, specifically the `bert-base-multilingual-cased` variant. BERT is a powerful pre-trained language model that can be fine-tuned for various natural language processing tasks, including sentiment analysis.
|
| 21 |
-
|
| 22 |
-
The model takes Nepali text as input and produces sentiment predictions as output. It uses tokenization techniques to convert the text into numerical representations and leverages the transformer-based architecture to capture contextual relationships between words in the text.
|
| 23 |
-
|
| 24 |
-
# Nepali Sentiment Analysis
|
| 25 |
-
|
| 26 |
-
This repository contains code for a Nepali Sentiment Analysis model. The model is trained to predict the sentiment (positive, negative, or neutral) of Nepali text.
|
| 27 |
-
|
| 28 |
-
## Dataset
|
| 29 |
-
|
| 30 |
The dataset used for training this model is sourced from [Shushant/NepaliSentiment](https://huggingface.co/datasets/Shushant/NepaliSentiment) on the Hugging Face Datasets Hub. The dataset consists of labelled Nepali text samples with corresponding sentiment labels.
|
| 31 |
|
| 32 |
## Model Architecture
|
|
@@ -49,10 +35,20 @@ To use the Nepali Sentiment Analysis model:
|
|
| 49 |
|
| 50 |
5. Evaluate the model's performance using suitable metrics such as accuracy, precision, recall, or F1-score.
|
| 51 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 52 |
## Repository Structure
|
| 53 |
|
| 54 |
-
- `
|
|
|
|
| 55 |
- `inference.ipynb`: Jupyter Notebook demonstrating how to perform inference using the trained model.
|
|
|
|
| 56 |
- `requirements.txt`: List of required dependencies for running the code.
|
| 57 |
- `README.md`: This readme file provides an overview of the repository.
|
| 58 |
|
|
@@ -74,7 +70,6 @@ During the training process, the model achieved the following accuracies for dif
|
|
| 74 |

|
| 75 |
|
| 76 |
|
| 77 |
-
|
| 78 |
To improve the accuracy of the model, you can consider making the following changes:
|
| 79 |
|
| 80 |
- Adjust the batch size: Try experimenting with different batch sizes to see if it has any impact on the model's performance. Sometimes, a smaller or larger batch size can lead to better results.
|
|
@@ -87,4 +82,4 @@ I encourage open-source contributors to explore ways to improve the accuracy of
|
|
| 87 |
|
| 88 |
## License
|
| 89 |
|
| 90 |
-
This project is licensed under the [MIT License](LICENSE).
|
|
|
|
| 13 |
|
| 14 |
## Dataset
|
| 15 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
The dataset used for training this model is sourced from [Shushant/NepaliSentiment](https://huggingface.co/datasets/Shushant/NepaliSentiment) on the Hugging Face Datasets Hub. The dataset consists of labelled Nepali text samples with corresponding sentiment labels.
|
| 17 |
|
| 18 |
## Model Architecture
|
|
|
|
| 35 |
|
| 36 |
5. Evaluate the model's performance using suitable metrics such as accuracy, precision, recall, or F1-score.
|
| 37 |
|
| 38 |
+
6. To try the model practically, open `nepali-sentiment-model-tryout.ipynb` in Jupyter Notebook.
|
| 39 |
+
|
| 40 |
+
7. In the `model-tryout.ipynb` file, provide the string you want to analyze for sentiment.
|
| 41 |
+
|
| 42 |
+
8. Run the cells in `model-tryout.ipynb` to obtain the predicted sentiment label for the provided string.
|
| 43 |
+
|
| 44 |
+
9. Optionally, you can also modify the code to analyze multiple strings or perform a batch analysis.
|
| 45 |
+
|
| 46 |
## Repository Structure
|
| 47 |
|
| 48 |
+
- `model-training.ipynb`: Jupyter Notebook containing the code for training the Nepali Sentiment Analysis model.
|
| 49 |
+
- `model-tryout.ipnyb` : Hupyter Notebook containing the code to tryout the Model
|
| 50 |
- `inference.ipynb`: Jupyter Notebook demonstrating how to perform inference using the trained model.
|
| 51 |
+
- `nepali-sentiment-model-tryout.ipynb`: Jupyter Notebook for trying the model practically with a string input.
|
| 52 |
- `requirements.txt`: List of required dependencies for running the code.
|
| 53 |
- `README.md`: This readme file provides an overview of the repository.
|
| 54 |
|
|
|
|
| 70 |

|
| 71 |
|
| 72 |
|
|
|
|
| 73 |
To improve the accuracy of the model, you can consider making the following changes:
|
| 74 |
|
| 75 |
- Adjust the batch size: Try experimenting with different batch sizes to see if it has any impact on the model's performance. Sometimes, a smaller or larger batch size can lead to better results.
|
|
|
|
| 82 |
|
| 83 |
## License
|
| 84 |
|
| 85 |
+
This project is licensed under the [MIT License](LICENSE).
|