Upload README.md

README.md

@@ -1,3 +1,199 @@
 ---
 license: apache-2.0
+language: zh
 ---
+
+
+# uie-mini
+
+## 介绍
+* **[PaddlePaddle/uie-mini](https://huggingface.co/PaddlePaddle/uie-medium)** 的 Pytorch 实现
+
+## 代码调用
+
+### forward
+> **Parameters**
+> * `input_ids: Optional[torch.Tensor] = None`
+> * `token_type_ids: Optional[torch.Tensor] = None`
+> * `position_ids: Optional[torch.Tensor] = None`
+> * `attention_mask: Optional[torch.Tensor] = None`
+> * `head_mask: Optional[torch.Tensor] = None`
+> * `inputs_embeds: Optional[torch.Tensor] = None`
+> * `start_positions: Optional[torch.Tensor] = None`
+> * `end_positions: Optional[torch.Tensor] = None`
+> * `output_attentions: Optional[bool] = None`
+> * `output_hidden_states: Optional[bool] = None`
+> * `return_dict: Optional[bool] = None`
+> 
+> **Returns**  *UIEModelOutput or tuple(torch.FloatTensor)*
+
+### predict
+> **Parameters**
+> * `schema: Union[Dict, List[str], str]`
+> * `input_texts: Union[List[str], str]`
+> * `tokenizer: PreTrainedTokenizerFast`
+> * `max_length: int = 512`
+> * `batch_size: int = 32`
+> * `position_prob: int = 0.5`
+> * `progress_hook=None`
+>
+> **Returns**  * List[Dict]*
+
+```python
+from tqdm import tqdm
+from transformers import AutoModel, AutoTokenizer
+model = AutoModel.from_pretrained('Casually/uie-mini', trust_remote_code=True)
+model.eval().to('cuda')
+tokenizer = AutoTokenizer.from_pretrained('Casually/uie-mini')
+hook = tqdm()
+schema = {'地震触发词': ['地震强度', '时间', '震中位置', '震源深度']}
+model.predict(schema=schema,
+              input_texts='中国地震台网正式测定：5月16日06时08分在云南临沧市凤庆县(北纬24.34度，东经99.98度)发生3.5级地震，震源深度10千米。',
+              tokenizer=tokenizer,
+              progress_hook=hook
+              )
+```
+```ipython
+100%|██████████| 5/5 [00:00<00:00, 10.35it/s]
+[{'地震触发词': [{'end': 58,
+             'probability': 0.9851177681976395,
+             'relations': {'地震强度': [{'end': 56,
+                                     'probability': 0.9975105089050018,
+                                     'start': 52,
+                                     'text': '3.5级'}],
+                           '时间': [{'end': 22,
+                                   'probability': 0.9905343932286996,
+                                   'start': 11,
+                                   'text': '5月16日06时08分'}],
+                           '震中位置': [{'end': 50,
+                                     'probability': 0.6928305512584316,
+                                     'start': 23,
+                                     'text': '云南临沧市凤庆县(北纬24.34度，东经99.98度)'}],
+                           '震源深度': [{'end': 67,
+                                     'probability': 0.9982960576575515,
+                                     'start': 63,
+                                     'text': '10千米'}]},
+             'start': 56,
+             'text': '地震'}]}]
+```
+
+## 应用示例
+
+### 实体抽取
+
+```python
+from transformers import AutoModel, AutoTokenizer
+model = AutoModel.from_pretrained('Casually/uie-mini', trust_remote_code=True)
+model.eval().to('cuda')
+tokenizer = AutoTokenizer.from_pretrained('Casually/uie-mini')
+schema = ['时间', '选手', '赛事名称']
+res = model.predict(schema=schema,
+                    input_texts="2月8日上午北京冬奥会自由式滑雪女子大跳台决赛中中国选手谷爱凌以188.25分获得金牌！",
+                    tokenizer=tokenizer,
+                    )
+```
+
+```ipython
+>>> from pprint import pprint
+>>> pprint(res)
+[{'时间': [{'end': 6,
+          'probability': 0.9860749685197305,
+          'start': 0,
+          'text': '2月8日上午'}],
+  '赛事名称': [{'end': 23,
+            'probability': 0.5851424014523587,
+            'start': 6,
+            'text': '北京冬奥会自由式滑雪女子大跳台决赛'}],
+  '选手': [{'end': 31,
+          'probability': 0.9944670393497361,
+          'start': 28,
+          'text': '谷爱凌'}]}]
+```
+
+
+
+### 关系抽取
+```python
+from transformers import AutoModel, AutoTokenizer
+model = AutoModel.from_pretrained('Casually/uie-mini', trust_remote_code=True)
+model.eval().to('cuda')
+tokenizer = AutoTokenizer.from_pretrained('Casually/uie-mini')
+schema = {'竞赛名称': ['主办方', '承办方', '已举办次数']}
+res = model.predict(schema=schema,
+                    input_texts='2022语言与智能技术竞赛由中国中文信息学会和中国计算机学会联合主办，百度公司、中国中文信息学会评测工作委员会和中国计算机学会自然语言处理专委会承办，已连续举办4届，成为全球最热门的中文NLP赛事之一。',
+                    tokenizer=tokenizer,
+                    )
+```
+
+```ipython
+>>> from pprint import pprint
+>>> pprint(res)
+[{'竞赛名称': [{'end': 13,
+            'probability': 0.8157239396095974,
+            'relations': {'主办方': [{'end': 22,
+                                   'probability': 0.7056978695139939,
+                                   'start': 14,
+                                   'text': '中国中文信息学会'},
+                                  {'end': 30,
+                                   'probability': 0.6668484149279692,
+                                   'start': 23,
+                                   'text': '中国计算机学会'}],
+                          '已举办次数': [{'end': 82,
+                                     'probability': 0.9588643277680688,
+                                     'start': 80,
+                                     'text': '4届'}],
+                          '承办方': [{'end': 39,
+                                   'probability': 0.66239921383184,
+                                   'start': 35,
+                                   'text': '百度公司'},
+                                  {'end': 72,
+                                   'probability': 0.33517418841715596,
+                                   'start': 56,
+                                   'text': '中国计算机学会自然语言处理专委会'},
+                                  {'end': 55,
+                                   'probability': 0.3918968860892278,
+                                   'start': 40,
+                                   'text': '中国中文信息学会评测工作委员会'}]},
+            'start': 0,
+            'text': '2022语言与智能技术竞赛'}]}]
+```
+
+### 事件抽取
+
+```python
+from transformers import AutoModel, AutoTokenizer
+model = AutoModel.from_pretrained('Casually/uie-mini', trust_remote_code=True)
+model.eval().to('cuda')
+tokenizer = AutoTokenizer.from_pretrained('Casually/uie-mini')
+schema = {'地震触发词': ['地震强度', '时间', '震中位置', '震源深度']}
+res = model.predict(schema=schema,
+                    input_texts='中国地震台网正式测定：5月16日06时08分在云南临沧市凤庆县(北纬24.34度，东经99.98度)发生3.5级地震，震源深度10千米。',
+                    tokenizer=tokenizer,
+                    )
+```
+
+```ipython
+>>> from pprint import pprint
+>>> pprint(res)
+[{'地震触发词': [{'end': 58,
+             'probability': 0.9851177681976395,
+             'relations': {'地震强度': [{'end': 56,
+                                     'probability': 0.9975105089050018,
+                                     'start': 52,
+                                     'text': '3.5级'}],
+                           '时间': [{'end': 22,
+                                   'probability': 0.9905343932286996,
+                                   'start': 11,
+                                   'text': '5月16日06时08分'}],
+                           '震中位置': [{'end': 50,
+                                     'probability': 0.6928305512584316,
+                                     'start': 23,
+                                     'text': '云南临沧市凤庆县(北纬24.34度，东经99.98度)'}],
+                           '震源深度': [{'end': 67,
+                                     'probability': 0.9982960576575515,
+                                     'start': 63,
+                                     'text': '10千米'}]},
+             'start': 56,
+             'text': '地震'}]}]
+
+```