Update README.md
Browse files
    	
        README.md
    CHANGED
    
    | @@ -1,3 +1,30 @@ | |
| 1 | 
             
            ---
         | 
| 2 | 
             
            license: mit
         | 
|  | |
|  | |
| 3 | 
             
            ---
         | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 1 | 
             
            ---
         | 
| 2 | 
             
            license: mit
         | 
| 3 | 
            +
            language:
         | 
| 4 | 
            +
            - en
         | 
| 5 | 
             
            ---
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            # compnet-renard/bert-base-cased-literary-coref
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            This model should be used with [tibert](https://github.com/CompNet/Tibert), a BERT-based end-to-end coreference solver.
         | 
| 10 | 
            +
             | 
| 11 | 
            +
            Example code:
         | 
| 12 | 
            +
             | 
| 13 | 
            +
            ```python
         | 
| 14 | 
            +
            from tibert import BertForCoreferenceResolution, predict_coref_simple
         | 
| 15 | 
            +
            from tibert.utils import pprint_coreference_document
         | 
| 16 | 
            +
            from transformers import BertTokenizerFast
         | 
| 17 | 
            +
             | 
| 18 | 
            +
            model = BertForCoreferenceResolution.from_pretrained(
         | 
| 19 | 
            +
                "compnet-renard/bert-base-cased-literary-coref"
         | 
| 20 | 
            +
            )
         | 
| 21 | 
            +
            tokenizer = BertTokenizerFast.from_pretrained("bert-base-cased")
         | 
| 22 | 
            +
             | 
| 23 | 
            +
            coref_out = predict_coref_simple(
         | 
| 24 | 
            +
                "Sli did not want the earpods. He didn't like them.", model, tokenizer
         | 
| 25 | 
            +
            )
         | 
| 26 | 
            +
             | 
| 27 | 
            +
            pprint_coreference_document(coref_out)
         | 
| 28 | 
            +
            ```
         | 
| 29 | 
            +
             | 
| 30 | 
            +
            `>>> (0 Sli ) did not want the earpods. (0 He ) didn't like them.`
         | 
