Main brez modelov

2022-12-07 06:22:36 +01:00
parent 89fa62796e
commit 1cd7663d49
93 changed files with 98496 additions and 508 deletions
@@ -0,0 +1,57 @@
+# Automatic Term Extraction API
+
+## 1. Description
+In this repo, we wrote an API to inference SloBERTa term extractor, whose model has been trained with [RSDO5 corpus](https://www.clarin.si/repository/xmlui/handle/11356/1400). Feel free to check out this [repo](https://github.com/honghanhh/ate-2022) for better understanding about the methodology.
+
+---
+
+## 2. Requirements
+
+Please install all the necessary libraries noted in [requirements.txt](./requirements.txt) using this command:
+
+```
+pip install -r requirements.txt
+```
+
+## 3. Implementation
+
+Download the model from [pytorch_model.bin](https://kt-cloud.ijs.si/index.php/s/T4qtSKxbxgqr6c5) and save it into `./model/term_extractor/`.
+
+Run the following command on the terminal:
+
+```python
+main.py
+```
+
+A link will be show on the terminal so that you can access to the API and test requests.
+```python
+ * Serving Flask app 'main'
+ * Debug mode: on
+WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
+ * Running on http://127.0.0.1:5000
+Press CTRL+C to quit
+ * Restarting with stat
+ * Debugger is active!
+ * Debugger PIN: 185-520-689
+```
+
+We suggest you use POSTMAN or Hoppscotch to test the API with an uploaded file as the output whose format is CONLL-like (plese check out [temp_1.conllu](temp_1.conllu)). See the demonstration as the image below.
+
+![demo](./imgs/demo.png)
+
+## 4. Docker version
+Run the following command:
+```python
+docker build -t ate .  
+docker run -d -p 5000:5000 ate
+```
+
+## 5. References
+The term extraction tool is an updated version of Tran et al. (2022), using the SloBERTa model.
+
+Hanh Thi Hong Tran, Matej Martinc, Andraz Repar, Antoine Doucet and Senja Pollak: A Transformer-based Sequence-labeling Approach to the Slovenian Cross-domain Automatic Term Extraction. Proc. of Jezikovne tehnologije in digitalna humanistika, 2022.
+
+## 6. Contributors:
+- 🐮 [TRAN Thi Hong Hanh](https://github.com/honghanhh) 🐮
+- Matej Martinc
+- Senja Pollak