Indonesian-NER-Spacy

SpaCy is an open-source Natural Language Processing (NLP) library that offers powerful tools for various language processing tasks. However, it does not natively support a Named Entity Recognition (NER) model for the Indonesian language. This project aims to bridge that gap by fine-tuning a SpaCy model specifically for Indonesian using the available dataset.

About
Getting Started
Installation
Usage
Contributing
Contact

About

This project provides a fine-tuned Named Entity Recognition (NER) model for the Indonesian language using SpaCy. By leveraging the available dataset, the model has been trained to recognize various entities within Indonesian text, such as names, organizations, locations, and more.

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Python 3.8+
SpaCy
Jupyter Notebook

Installation

Clone the repository:

git clone https://github.com/rrayhka/indonesian-ner-spacy.git
cd indonesian-ner-spacy

Install SpaCy:
```
pip install spacy
```
Ensure that SpaCy is correctly installed and the necessary SpaCy components are downloaded:
```
python -m spacy download en_core_web_sm
```

Usage

To fine-tune and test the Indonesian NER model, you can use the provided Jupyter notebooks:

Data Preparation: Run the convert_data.ipynb notebook to preprocess the dataset and convert it into a format suitable for training.
```
jupyter notebook convert_data.ipynb
```
Model Training: Use the modelling.ipynb notebook to fine-tune the SpaCy model on the Indonesian dataset.
```
jupyter notebook modelling.ipynb
```
Testing: After training, the model can be tested using the provided test dataset or any custom Indonesian text.
```
jupyter notebook modelling.ipynb
```

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

Inspiration

This project was inspired by this post by Yudanta, which provides a guide on training an Indonesian NER model from a blank SpaCy model. It served as a valuable reference in the creation and fine-tuning of this project.

Contact

Akhyar - khyar075@gmail.com

rrayhka/indonesian-ner-spacy