Skip to content

Commit d3fcc61

Browse files
committed
Update README.md
1 parent d19ad50 commit d3fcc61

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

docs/model_zoo/taskflow.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ seg(["第十四届全运会在西安举办", "三亚是一个美丽的城市"])
8383

8484
#### 自定义词典
8585

86-
用户可以通过装载自定义词典来定制化分词结果。
86+
用户可以通过装载自定义词典来定制化分词结果。词典文件每一行表示一个自定义item,可以由一个单词或者多个单词组成。
8787

88-
词典文件`custom_seg.txt`示例:
88+
词典文件`user_dict.txt`示例:
8989

9090
```text
9191
平原上的火焰
@@ -103,15 +103,15 @@ seg(["第十四届全运会在西安举办", "三亚是一个美丽的城市"])
103103
```python
104104
from paddlenlp import Taskflow
105105

106-
my_seg = Taskflow("word_segmentation", custom_vocab="custom_seg.txt")
106+
my_seg = Taskflow("word_segmentation", user_dict="user_dict.txt")
107107
my_seg("平原上的火焰计划于年末上映")
108108
>>> ['平原上的火焰', '计划', '', '', '', '上映']
109109
```
110110

111111
#### 可配置参数说明
112112

113113
* `batch_size`:批处理大小,请结合机器情况进行调整,默认为1。
114-
* `custom_vocab`:用户自定义词典文件,默认为None。
114+
* `user_dict`:用户自定义词典文件,默认为None。
115115

116116
### 词性标注
117117

@@ -140,9 +140,9 @@ tag(["第十四届全运会在西安举办", "三亚是一个美丽的城市"])
140140

141141
#### 自定义词典
142142

143-
用户可以通过装载自定义词典来定制化分词和词性标注结果。
143+
用户可以通过装载自定义词典来定制化分词和词性标注结果。词典文件每一行表示一个自定义item,可以由一个单词或者多个单词组成,单词后面可以添加自定义标签,格式为`item/tag`,如果不添加自定义标签,则使用模型默认标签。
144144

145-
词典文件`custom_pos.txt`示例:
145+
词典文件`user_dict.txt`示例:
146146

147147
```text
148148
赛里木湖/LAKE
@@ -162,15 +162,15 @@ tag(["第十四届全运会在西安举办", "三亚是一个美丽的城市"])
162162
```python
163163
from paddlenlp import Taskflow
164164

165-
my_pos = Taskflow("pos_tagging", custom_vocab="custom_pos.txt")
165+
my_pos = Taskflow("pos_tagging", user_dict="user_dict.txt")
166166
my_pos("赛里木湖是新疆海拔最高的高山湖泊")
167167
>>> [('赛里木湖', 'LAKE'), ('', 'v'), ('新疆', 'LOC'), ('海拔最高', 'n'), ('', 'u'), ('', 'a'), ('', 'n'), ('', 'n'), ('', 'n')]
168168
```
169169

170170
#### 可配置参数说明
171171

172172
* `batch_size`:批处理大小,请结合机器情况进行调整,默认值为1。
173-
* `custom_vocab`:用户自定义词典文件,默认为None。
173+
* `user_dict`:用户自定义词典文件,默认为None。
174174

175175
### 命名实体识别
176176

@@ -187,9 +187,9 @@ ner(["热梅茶是一道以梅子为主要原料制作的茶饮", "《孤女》
187187

188188
#### 自定义词典
189189

190-
用户可以通过装载自定义词典来定制化分词和词性标注结果。
190+
用户可以通过装载自定义词典来定制化分词和词性标注结果。词典文件每一行表示一个自定义item,可以由一个单词或者多个单词组成,单词后面可以添加自定义标签,格式为`item/tag`,如果不添加自定义标签,则使用模型默认标签。
191191

192-
词典文件`custom_ner.txt`示例:
192+
词典文件`user_dict.txt`示例:
193193

194194
```text
195195
长津湖/电影类_实体
@@ -209,7 +209,7 @@ ner(["热梅茶是一道以梅子为主要原料制作的茶饮", "《孤女》
209209
```python
210210
from paddlenlp import Taskflow
211211

212-
my_ner = Taskflow("ner", custom_vocab="custom_ner.txt")
212+
my_ner = Taskflow("ner", user_dict="user_dict.txt")
213213
my_ner("《长津湖》收尾,北美是最大海外票仓")
214214
>>> [('', 'w'), ('长津湖', '电影类_实体'), ('', 'w'), ('', '词汇用语'), ('', '术语类'), ('', 'w'), ('北美', '世界地区类'), ('', '肯定词'), ('', '修饰词'), ('', '修饰词'), ('海外票仓', '场所类')]
215215
```
@@ -229,7 +229,7 @@ my_ner = Taskflow("ner", params_path="/path/to/your/params", tag_path="/path/to/
229229
#### 可配置参数说明
230230

231231
* `batch_size`:批处理大小,请结合机器情况进行调整,默认为1。
232-
* `custom_vocab`:用户自定义词典文件,默认为None。
232+
* `user_dict`:用户自定义词典文件,默认为None。
233233
* `params_path`:模型参数文件路径,默认为None。
234234
* `tag_path`:标签文件路径,默认为None。
235235

paddlenlp/taskflow/lexical_analysis.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ class LacTask(Task):
9494
def __init__(self, task, model, **kwargs):
9595
super().__init__(task=task, model=model, **kwargs)
9696
self._usage = usage
97-
self._custom_vocab = self.kwargs[
98-
'custom_vocab'] if 'custom_vocab' in self.kwargs else None
97+
self._user_dict = self.kwargs[
98+
'user_dict'] if 'user_dict' in self.kwargs else None
9999
word_dict_path = download_file(
100100
self._task_path, "lac_params" + os.path.sep + "word.dic",
101101
URLS['lac_params'][0], URLS['lac_params'][1])
@@ -113,9 +113,9 @@ def __init__(self, task, model, **kwargs):
113113
self._id2tag_dict = dict(
114114
zip(self._tag_vocab.values(), self._tag_vocab.keys()))
115115
self._get_inference_model()
116-
if self._custom_vocab:
116+
if self._user_dict:
117117
self._custom = Customization()
118-
self._custom.load_customization(self._custom_vocab)
118+
self._custom.load_customization(self._user_dict)
119119
else:
120120
self._custom = None
121121

paddlenlp/taskflow/named_entity_recognition.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ class NERTask(WordTagTask):
5656

5757
def __init__(self, model, task, **kwargs):
5858
super().__init__(model=model, task=task, **kwargs)
59-
self._custom_vocab = self.kwargs[
60-
'custom_vocab'] if 'custom_vocab' in self.kwargs else None
61-
if self._custom_vocab:
59+
self._user_dict = self.kwargs[
60+
'user_dict'] if 'user_dict' in self.kwargs else None
61+
if self._user_dict:
6262
self._custom = Customization()
63-
self._custom.load_customization(self._custom_vocab)
63+
self._custom.load_customization(self._user_dict)
6464
else:
6565
self._custom = None
6666

0 commit comments

Comments
 (0)