Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,103 @@
+---
+language:
+  - en
+metrics:
+  - f1
+base_model:
+  - FacebookAI/roberta-base
+tags:
+  - parsing
+  - hashing
+  - unsupervised
+---
+
+## On Eliciting Syntax from Language Models via Hashing
+
+## Model Details
+
+This repository contains the implementation of [**Parserker v2**](https://aclanthology.org/2024.emnlp-main.479/), a
+hashing-based unsupervised parser trained on the Penn Treebank dataset using only the raw text (no syntactic annotations
+or tree labels).
+
+## Usage
+
+### Requirements
+
+`pip install transformers torch nltk torchrua`
+
+### Demo
+
+```python
+from nltk import TreePrettyPrinter
+from transformers import AutoModel, AutoTokenizer
+
+model = AutoModel.from_pretrained("yehzw/parserker", trust_remote_code=True)
+tokenizer = AutoTokenizer.from_pretrained("yehzw/parserker", trust_remote_code=True)
+
+model.eval()
+
+words, input_ids, duration = tokenizer([
+    "The quick brown fox jumps over the lazy dog",
+    "Have a nice day",
+])
+
+for w, s in zip(words, model.parse(input_ids, duration).tolist()):
+    t = model.to_tree(w, s)
+    t = TreePrettyPrinter(t).text()
+    print(t)
+```
+
+### Ouput Examples
+
+The quick brown fox jumps over the lazy dog
+
+```
+                                 854D                              
+             _____________________|_________                        
+            |                              DF41                    
+            |                      _________|____                   
+           955F                   |             DD59               
+  __________|_____                |     _________|____              
+ |               DC45             |    |             D457          
+ |      __________|____           |    |     _________|____         
+ |     |              DE45        |    |    |             DECD     
+ |     |           ____|____      |    |    |          ____|____    
+103B  C404       DC05      D60D  9300 C995 D0B7      DC8D      DE8D
+ |     |          |         |     |    |    |         |         |   
+The  quick      brown      fox  jumps over the       lazy      dog
+```
+
+Have a nice day
+
+```
+          955B               
+  _________|____              
+ |             8C57          
+ |     _________|____         
+ |    |             CEE5     
+ |    |          ____|____    
+151B 3817      8C04      8E2D
+ |    |         |         |   
+Have  a        nice      day 
+```
+
+## Citation
+
+```bib
+@inproceedings{wang-utiyama-2024-eliciting,
+    title = "On Eliciting Syntax from Language Models via Hashing",
+    author = "Wang, Yiran  and
+      Utiyama, Masao",
+    editor = "Al-Onaizan, Yaser  and
+      Bansal, Mohit  and
+      Chen, Yun-Nung",
+    booktitle = "Proceedings of the 2024 Conference on Empirical Methods in Natural Language Processing",
+    month = nov,
+    year = "2024",
+    address = "Miami, Florida, USA",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2024.emnlp-main.479/",
+    doi = "10.18653/v1/2024.emnlp-main.479",
+    pages = "8412--8427"
+}
+```