# [Macropodus](https://github.com/yongzhuo/Macropodus) ![PyPI - Python Version](https://img.shields.io/badge/python-3.6-blue.svg) [![PyPI](https://img.shields.io/pypi/v/Macropodus)](https://pypi.org/project/Macropodus/) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://img.shields.io/github/license/mashape/apistatus.svg) [![PyPI_downloads](https://img.shields.io/pypi/dm/Macropodus)](https://pypi.org/project/Macropodus/) [![Stars](https://img.shields.io/github/stars/yongzhuo/Macropodus?style=social)](https://github.com/yongzhuo/Macropodus/stargazers) [![Forks](https://img.shields.io/github/forks/yongzhuo/Macropodus.svg?style=social)](https://github.com/yongzhuo/Macropodus/network/members) [![Join the chat at https://gitter.im/yongzhuo/Macropodus](https://badges.gitter.im/yongzhuo/Macropodus.svg)](https://gitter.im/yongzhuo/Macropodus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) >>> Macropodus是一个以Albert+BiLSTM+CRF网络架构为基础,用大规模中文语料训练的自然语言处理工具包。将提供中文分词、词性标注、命名实体识别、关键词抽取、文本摘要、新词发现、文本相似度、计算器、数字转换、拼音转换、繁简转换等常见NLP功能。 ## 目录 * [安装](#安装) * [使用方式](#使用方式) * [参考/引用](#参考/引用) * [FAQ](#FAQ) # 安装 0. 注意事项 ``` 默认不安装nlg-yongzhuo, 如果需要该功能自行安装; 默认不指定numpy, pandas, scikit-learn版本, 过高或者过低的版本可能不支持 标准版本的依赖包详见 requirements-all.txt ``` 1. 通过PyPI安装(模型文件另需下载, 详见[命名实体提取](#命名实体提取), [词性标注](#词性标注)): ``` pip install macropodus ``` 2. 使用镜像源,例如: ``` pip install -i https://pypi.tuna.tsinghua.edu.cn/simple macropodus ``` # 使用方式 ## 快速使用 ```python3 import macropodus sen_calculate = "23 + 13 * (25+(-9-2-5-2*3-6/3-40*4/(2-3)/5+6*3))加根号144你算得几多" sen_chi2num = "三千零七十八亿三千零十五万零三百一十二点一九九四" sen_num2chi = 1994.1994 sen_roman2int = "IX" sen_int2roman = 132 sent1 = "PageRank算法简介" sent2 = "百度百科如是介绍他的思想:PageRank通过网络浩瀚的超链接关系来确定一个页面的等级。" summary = "PageRank算法简介。" \ "是上世纪90年代末提出的一种计算网页权重的算法! " \ "当时,互联网技术突飞猛进,各种网页网站爆炸式增长。 " \ "业界急需一种相对比较准确的网页重要性计算方法。 " \ "是人们能够从海量互联网世界中找出自己需要的信息。 " \ "百度百科如是介绍他的思想:PageRank通过网络浩瀚的超链接关系来确定一个页面的等级。 " \ "Google把从A页面到B页面的链接解释为A页面给B页面投票。 " \ "Google根据投票来源甚至来源的来源,即链接到A页面的页面。 " \ "和投票目标的等级来决定新的等级。简单的说, " \ "一个高等级的页面可以使其他低等级页面的等级提升。 " \ "具体说来就是,PageRank有两个基本思想,也可以说是假设。 " \ "即数量假设:一个网页被越多的其他页面链接,就越重)。 " \ "质量假设:一个网页越是被高质量的网页链接,就越重要。 " \ "总的来说就是一句话,从全局角度考虑,获取重要的信。 " # 分词(词典最大概率分词DAG) words = macropodus.cut(summary) print(words) # 新词发现 new_words = macropodus.find(summary) print(new_words) # 文本摘要 sum = macropodus.summarize(summary) print(sum) # 关键词抽取 keyword = macropodus.keyword(summary) print(keyword) # 文本相似度 sim = macropodus.sim(sent1, sent2) print(sim) # tookit # 计算器 score_calcul = macropodus.calculate(sen_calculate) print(score_calcul) # 中文数字与阿拉伯数字相互转化 res_chi2num = macropodus.chi2num(sen_chi2num) print(res_chi2num) res_num2chi = macropodus.num2chi(sen_num2chi) print(res_num2chi) # 阿拉伯数字与罗马数字相互转化 res_roman2int = macropodus.roman2int(sen_roman2int) print(res_roman2int) res_int2roman = macropodus.int2roman(sen_int2roman) print(res_int2roman) # 中文汉字转拼音 res_pinyin = macropodus.pinyin(summary) print(res_pinyin) # 中文繁简转化 res_zh2han = macropodus.zh2han(summary) print(res_zh2han) res_han2zh = macropodus.han2zh(res_zh2han) print(res_han2zh) ``` ## 中文分词 各种分词方法 ```python3 import macropodus # 用户词典 macropodus.add_word(word="斗鱼科") macropodus.add_word(word="鲈形目") # 不持久化, 当前有效 macropodus.save_add_words(word_freqs={"喜斗":32, "护卵":64, "护幼":132}) # 持久化保存到用户字典 sent = "斗鱼属,Macropodus (1801),鲈形目斗鱼科的一属鱼类。本属鱼类通称斗鱼。因喜斗而得名。分布于亚洲东南部。中国有2种,即叉尾斗鱼,分布于长江及以南各省;叉尾斗鱼,分布于辽河到珠江流域。其喜栖居于小溪、河沟、池塘、稻田等缓流或静水中。雄鱼好斗,产卵期集草成巢,雄鱼口吐粘液泡沫,雌鱼产卵其中,卵浮性,受精卵在泡沫内孵化。雄鱼尚有护卵和护幼现象。" # 分词 sents = macropodus.cut_bidirectional(sent) print("cut_bidirectional: " + " ".join(sents)) sents = macropodus.cut_forward(sent) print("cut_forward: " + " ".join(sents)) sents = macropodus.cut_reverse(sent) print("cut_reverse: " + " ".join(sents)) sents = macropodus.cut_search(sent) print("cut_search: " + " ".join(sents)) # DAG sents = macropodus.cut_dag(sent) print("cut_dag: " + " ".join(sents)) ``` ## 文本相似度 文本相似度主要使用词向量, 余弦相似度 或 jaccard相似度 ```python3 import macropodus sent1="叉尾斗鱼是一种观赏性动物" sent2="中国斗鱼生性好斗,适应性强,能在恶劣的环境中生存" # 文本相似度(similarity) sents = macropodus.sim(sent1, sent2, type_sim="total", type_encode="avg") print(sents) sents = macropodus.sim(sent1, sent2, type_sim="cosine", type_encode="single") print(sents) ``` ## 文本摘要 文本摘要方法有text_pronouns, text_teaser, word_sign, textrank, lead3, mmr, lda, lsi, nmf ```python3 import macropodus summary = "PageRank算法简介。" \ "是上世纪90年代末提出的一种计算网页权重的算法! " \ "当时,互联网技术突飞猛进,各种网页网站爆炸式增长。 " \ "业界急需一种相对比较准确的网页重要性计算方法。 " \ "是人们能够从海量互联网世界中找出自己需要的信息。 " \ "百度百科如是介绍他的思想:PageRank通过网络浩瀚的超链接关系来确定一个页面的等级。 " \ "Google把从A页面到B页面的链接解释为A页面给B页面投票。 " \ "Google根据投票来源甚至来源的来源,即链接到A页面的页面。 " \ "和投票目标的等级来决定新的等级。简单的说, " \ "一个高等级的页面可以使其他低等级页面的等级提升。 " \ "具体说来就是,PageRank有两个基本思想,也可以说是假设。 " \ "即数量假设:一个网页被越多的其他页面链接,就越重)。 " \ "质量假设:一个网页越是被高质量的网页链接,就越重要。 " \ "总的来说就是一句话,从全局角度考虑,获取重要的信。 " # 文本摘要(summarize, 默认接口) sents = macropodus.summarize(summary) print(sents) # 文本摘要(summarization, 可定义方法, 提供9种文本摘要方法, 'lda', 'mmr', 'textrank', 'text_teaser') sents = macropodus.summarization(text=summary, type_summarize="lda") print(sents) ``` ## 新词发现 新词发现主要使用凝固度, 左熵, 右熵, 词频等方案, 综合考虑 ```python3 import macropodus summary = "PageRank算法简介。" \ "是上世纪90年代末提出的一种计算网页权重的算法! " \ "当时,互联网技术突飞猛进,各种网页网站爆炸式增长。 " \ "业界急需一种相对比较准确的网页重要性计算方法。 " \ "是人们能够从海量互联网世界中找出自己需要的信息。 " \ "百度百科如是介绍他的思想:PageRank通过网络浩瀚的超链接关系来确定一个页面的等级。 " \ "Google把从A页面到B页面的链接解释为A页面给B页面投票。 " \ "Google根据投票来源甚至来源的来源,即链接到A页面的页面。 " \ "和投票目标的等级来决定新的等级。简单的说, " \ "一个高等级的页面可以使其他低等级页面的等级提升。 " \ "具体说来就是,PageRank有两个基本思想,也可以说是假设。 " \ "即数量假设:一个网页被越多的其他页面链接,就越重)。 " \ "质量假设:一个网页越是被高质量的网页链接,就越重要。 " \ "总的来说就是一句话,从全局角度考虑,获取重要的信。 " # 新词发现(findword, 默认接口) sents = macropodus.find(text=summary, use_type="text", use_avg=False, use_filter=False, use_output=True, freq_min=2, len_max=5, entropy_min=2.0, aggregation_min=3.2) print(sents) ``` ## 关键词 关键词抽取使用的是textrank, 边关系构建: 1. 字向量构建句向量; 2. 余弦相似度计算边得分 ```python3 import macropodus sent = "斗鱼属,Macropodus (1801),鲈形目斗鱼科的一属鱼类。本属鱼类通称斗鱼。因喜斗而得名。分布于亚洲东南部。中国有2种,即叉尾斗鱼,分布于长江及以南各省;叉尾斗鱼,分布于辽河到珠江流域。其喜栖居于小溪、河沟、池塘、稻田等缓流或静水中。雄鱼好斗,产卵期集草成巢,雄鱼口吐粘液泡沫,雌鱼产卵其中,卵浮性,受精卵在泡沫内孵化。雄鱼尚有护卵和护幼现象。" # 关键词(keyword) sents = macropodus.keyword(sent) print(sents) ``` ## 命名实体提取 * ner, albert+bilstm+crf网络架构, 最大支持126个字符; * 需要安装tensorflow==1.15.0, keras-bert==0.80.0, keras-adaptive-softmax==0.6.0(pip安装不默认下载, 1.15.0以下未实验, 1.13以上应该可以); * 需要下载模型(pip安装不默认下载, 将ner_albert_people_1998覆盖到安装目录macropodus/data/model); * 模型地址在[https://pan.baidu.com/s/1I3vydhmFEQ9nuPG2fDou8Q](https://pan.baidu.com/s/1I3vydhmFEQ9nuPG2fDou8Q), 提取码:rket; ```python3 import macropodus summary = "美丽的广西是我国华南地区的一颗璀璨的明珠,山清水秀生态美,风生水起万象新。" res_ner = macropodus.ner(summary) print(res_ner) res_ners = macropodus.ners([summary]) print(res_ners) ``` ## 词性标注 * pos tag, albert+bilstm+crf网络架构, 最大支持126个字符; * 需要安装tensorflow==1.15.0, keras-bert==0.80.0, keras-adaptive-softmax==0.6.0(pip安装不默认下载, 1.15.0以下未实验, 1.13以上应该可以); * 需要下载模型(pip安装不默认下载, 将tag_albert_people_1998覆盖到安装目录macropodus/data/model); * 模型地址在[https://pan.baidu.com/s/1I3vydhmFEQ9nuPG2fDou8Q](https://pan.baidu.com/s/1I3vydhmFEQ9nuPG2fDou8Q), 提取码:rket; ```python3 import macropodus summary = "美丽的广西是我国华南地区的一颗璀璨的明珠,山清水秀生态美,风生水起万象新。" res_postag = macropodus.postag(summary) print(res_postag) res_postags = macropodus.postags([summary]) print(res_postags) ``` ## 常用小工具(tookit) 工具包括科学计算器, 中文繁体-简体转换, 阿拉伯-中文数字转换, 罗马数字-阿拉伯数字转换, 中文拼音 ```python3 import macropodus sen_calculate = "23 + 13 * (25+(-9-2-5-2*3-6/3-40*4/(2-3)/5+6*3))加根号144你算得几多" sen_chi2num = "三千零七十八亿三千零十五万零三百一十二点一九九四" sen_num2chi = 1994.1994 sen_roman2num = "IX" sen_num2roman = 132 # tookit, 科学计算器 score_calcul = macropodus.calculate(sen_calculate) print(score_calcul) # tookit, 中文数字转阿拉伯 res_chi2num = macropodus.chi2num(sen_chi2num) print(res_chi2num) # tookit, 阿拉伯数字转中文 res_num2chi = macropodus.num2chi(sen_num2chi) print(res_num2chi) # tookit, 阿拉伯数字转罗马数字 res_roman2num = macropodus.roman2num(sen_roman2num) print(res_roman2num) # tookit, 罗马数字转阿拉伯数字 res_num2roman = macropodus.num2roman(sen_num2roman) print(res_num2roman) # 中文汉字转拼音 res_pinyin = macropodus.pinyin(summary) print(res_pinyin) # 中文繁体转简体 res_zh2han = macropodus.zh2han(summary) print(res_zh2han) # 中文简体转繁体 res_han2zh = macropodus.han2zh(res_zh2han) print(res_han2zh) ``` # 参考/引用 * StringPreHandler(提取数字,纯数字):[https://github.com/zhanzecheng/Time_NLP](https://github.com/zhanzecheng/Time_NLP) * textrank_gensim: [https://github.com/RaRe-Technologies/gensim](https://github.com/RaRe-Technologies/gensim) * 最大概率(DAG-动态规划)词典分词: [https://github.com/fxsjy/jieba](https://github.com/fxsjy/jieba) * CRF(-未解决): [https://github.com/BrikerMan/Kashgari](https://github.com/BrikerMan/Kashgari) # Reference For citing this work, you can refer to the present GitHub project. For example, with BibTeX: ``` @misc{Macropodus, howpublished = {\url{https://github.com/yongzhuo/Macropodus}}, title = {Macropodus}, author = {Yongzhuo Mo}, publisher = {GitHub}, year = {2020} } ```