Package: dadmatools
DadmaTools: A Python NLP Library for PersianNamed Entity Recognition|Part of Speech Tagging|Dependency Parsing|Informal To FormalConstituency Parsing|Chunking|Kasreh Ezafe DetectionSpellchecker|Normalizer|Tokenizer|Lemmatizer|Sentiment AnalysisDadmaToolsDadmaTools is a repository for Natural Language Processing resources for the Persian Language. The aim is to make it easier and more applicable to practitioners in the industry to use Persian NLP, and hence this project is licensed to allow commercial use. The project features code examples on how to use the models in popular NLP frameworks such as spaCy and Transformers, as well as Deep Learning frameworks such as PyTorch. Furthermore, DadmaTools support common Persian embedding and Persian datasets.
for more details about how to use this tool read the instruction below.Contents:InstallationNLP ModelsNormalizerPipline (tok,lem,dep,pos,cons,chunk,kasreh,spellchecker)DatasetsEmbeddingsEvaluationHow to use in colabCite usInstallationTo get started using DadmaTools in your python project, simply install via the pip package. Note that installing the default pip package
will not install all NLP libraries because we want you to have the freedom to limit the dependency on what you use. Instead, we provide you with an installation option if you want to install all the required dependencies.Install with pipTo get started using DadmaTools, simply install the project with pip:pipinstalldadmatoolsNote that the default installation of DadmaToolsdoesinstall other NLP libraries such as SpaCy and supar.You can check therequirements.txtfile to see what version the packages has been tested with.Install from githubAlternatively you can install the latest version from github using:pipinstallgit+https://github.com/Dadmatech/dadmatools.gitNLP ModelsNatural Language Processing is an active area of research, and it consists of many different tasks.
The DadmaTools repository provides an overview of Persian models for some of the most basic NLP tasks (and is continuously evolving).Here is the list of NLP tasks we currently cover in the repository. These NLP tasks are defined as pipelines. Therefore, a pipeline list must be created and passed through the model. This will allow the user to choose the only task needed without loading others.
Each task has its abbreviation as follows:Named Entity Recognition:nerPart of speech tagging:posDependency parsing:depConstituency parsing:consKasreh Ezafe Detection:kasrehChunking:chunkLemmatizing:lemTokenizing:tokSpellchecker:spellcheckerNormalizinginformal2formal:itfSentiment analysis:sentNotethat the normalizer can be used outside of the pipeline as there are several configs (the default config is in the pipeline with the name of def-norm).Notethat if no pipeline is passed to the model, the tokenizer will be loaded as default.Normalizercleaning text and unify characters.Note: None means no action!fromdadmatools.normalizerimportNormalizernormalizer=Normalizer(full_cleaning=False,unify_chars=True,refine_punc_spacing=True,remove_extra_space=True,remove_puncs=False,remove_html=False,remove_stop_word=False,replace_email_with="<EMAIL>",replace_number_with=None,replace_url_with="",replace_mobile_number_with=None,replace_emoji_with=None,replace_home_number_with=None)text="""<p>دادماتولز اولین نسخش سال ۱۴۰۰ منتشر شده.امیدواریم که این تولز بتونه کار با متن رو براتون شیرین‌تر و راحت‌تر کنهلطفا با ایمیل dadmatools@dadmatech.ir با ما در ارتباط باشیدآدرس گیت‌هاب هم که خب معرف حضور مبارک هست:https://github.com/Dadmatech/DadmaTools</p>"""normalized_text=normalizer.normalize(text)# <p> دادماتولز اولین نسخش سال 1400 منتشر شده. امیدواریم که این تولز بتونه کار با متن رو براتون شیرین‌تر و راحت‌تر کنه لطفا با ایمیل <EMAIL> با ما در ارتباط باشید آدرس گیت‌هاب هم که خب معرف حضور مبارک هست: </p># full cleaningnormalizer=Normalizer(full_cleaning=True)normalized_text=normalizer.normalize(text)# دادماتولز نسخش سال منتشر تولز بتونه کار متن براتون شیرین‌تر راحت‌تر کنه ایمیل ارتباط آدرس گیت‌هاب معرف حضور مبارکPipelineContaining Tokenizer, Lemmatizer, POS Tagger, Dependancy Parser, Constituency Parser, Kasreh, Spellcheker, Infromal To Formal, Name Entity Recognation.importdadmatools.pipeline.languageaslanguage# here lemmatizer and pos tagger will be loaded# as tokenizer is the default tool, it will be loaded as well even without callingpips='tok, lem, pos, dep, chunk, cons, spellchecker, kasreh, itf, ner, sent'nlp=language.Pipeline(pips)# doc is an SpaCy objectdoc=nlp('کشور بزرگ ایران توانسته در طی سال‌ها اغشار مختلفی از قومیت‌های گوناگون رو به خوبی تو خودش  جا بده')docobject has different extensions. First, there aresentencesindocwhich is the list of the list ofToken. EachTokenalso has its own extensions. Note that we defined our own extension as well in DadmaTools. If any pipeline related to the specific extensions is not called, that extension will have no value.To better see the results which you can use this code:print(doc){'spellchecker':{'orginal':'کشور بزرگ ایران توانسته در طی سال\u200cها اغشار مختلفی از قومیت\u200cهای گوناگون رو به خوبی تو خودش  جا بده','corrected':'کشور بزرگ ایران توانسته در طی سال\u200cها اقشار مختلفی از قومیت\u200cهای گوناگون رو به خوبی تو خودش جا بده','checked_words':[('اغشار','اقشار')]},'itf':' کشور بزرگ ایران توانسته در طی سال\u200cها اغشار مختلفی از قومیت های گوناگون را به خوبی در خودش جا بده','sentences':[{'id':1,'tokens':[{'id':1,'text':'کشور','upos':'NOUN','xpos':'N_PL','feats':'Number=Plur|Person=2|Polarity=Neg|Tense=Pres','head':14,'deprel':'nsubj','lemma':'کشور','ner':'O','kasreh':'S-kasreh'},{'id':2,'text':'بزرگ','upos':'ADJ','xpos':'ADJ','feats':'Degree=Pos','head':8,'deprel':'amod','lemma':'بزرگ','ner':'O','kasreh':'S-kasreh'},{'id':3,'text':'ایران','upos':'SCONJ','xpos':'CON','feats':'Number=Plur|Person=3|PronType=Prs','head':2,'deprel':'nmod:poss','lemma':'ایران','ner':'S-loc','kasreh':'O'},{'id':4,'text':'توانسته','upos':'VERB','xpos':'V_PP','feats':'Number=Sing|Person=3|VerbForm=Part','head':14,'deprel':'aux','lemma':'توانست#توان','ner':'O','kasreh':'O'},{'id':5,'text':'در','upos':'ADP','xpos':'P','head':14,'deprel':'case','lemma':'در','ner':'O','kasreh':'O'},{'id':6,'text':'طی','upos':'ADP','xpos':'P','head':5,'deprel':'fixed','lemma':'طی','ner':'O','kasreh':'S-kasreh'},{'id':7,'text':'سال\u200cها','upos':'AUX','xpos':'V_PRS','feats':'Number=Sing|Person=3|Tense=Pres','head':14,'deprel':'fixed','lemma':'سال','ner':'O','kasreh':'O'},{'id':8,'text':'اغشار','upos':'NOUN','xpos':'N_PL','feats':'Number=Plur','head':19,'deprel':'nsubj','lemma':'اغشار','ner':'O','kasreh':'S-kasreh'},{'id':9,'text':'مختلفی','upos':'ADJ','xpos':'ADJ','feats':'Degree=Pos','head':8,'deprel':'amod','lemma':'مختلفی','ner':'O','kasreh':'O'},{'id':10,'text':'از','upos':'ADP','xpos':'P','head':15,'deprel':'case','lemma':'از','ner':'O','kasreh':'O'},{'id':11,'text':'قومیت\u200cهای','upos':'NOUN','xpos':'N_PL','feats':'Number=Plur','head':8,'deprel':'nmod:poss','lemma':'قومیت','ner':'O','kasreh':'S-kasreh'},{'id':12,'text':'گوناگون','upos':'ADJ','xpos':'ADJ','feats':'Degree=Pos','head':11,'deprel':'amod','lemma':'گوناگون','ner':'O','kasreh':'O'},{'id':13,'text':'رو','upos':'PART','xpos':'CLITIC','head':8,'deprel':'case','lemma':'رو','ner':'O','kasreh':'O'},{'id':14,'text':'به','upos':'ADP','xpos':'P','head':19,'deprel':'case','lemma':'به','ner':'O','kasreh':'O'},{'id':15,'text':'خوبی','upos':'ADJ','xpos':'ADJ','feats':'Degree=Pos','head':14,'deprel':'advcl','lemma':'خوب','ner':'O','kasreh':'O'},{'id':16,'text':'تو','upos':'ADP','xpos':'P','feats':'Number=Sing|Person=2|PronType=Prs','head':19,'deprel':'case','lemma':'تو','ner':'O','kasreh':'O'},{'id':17,'text':'خودش','upos':'PRON','xpos':'PRO','feats':'Number=Sing|Person=3|PronType=Prs|Reflex=Yes','head':19,'deprel':'obl','lemma':'خودش','ner':'O','kasreh':'O'},{'id':18,'text':'جا','upos':'VERB','xpos':'PREV','feats':'Number=Sing|Person=3|Tense=Pres','head':19,'deprel':'compound:lvc','lemma':'جا','ner':'O','kasreh':'O'},{'id':19,'text':'بده','upos':'VERB','xpos':'V_SUB','feats':'Mood=Sub','head':0,'deprel':'root','lemma':'داد#ده','ner':'O','kasreh':'O'}]}],'lang':'persian','sentiment':[{'label':'positive','score':0.7366364598274231}]}Loading Persian NLP DatasetsWe provide an easy-to-use way to load some popular Persian NLP datasetsHere is the list of supported datasets.DatasetTaskPersianNERNamed Entity RecognitionARMANNamed Entity RecognitionPeymaNamed Entity RecognitionFarsTailTextual EntailmentFaSpellSpell CheckingPersianNewsText ClassificationPerUDTUniversal DependencyPnSummaryText SummarizationSnappfoodSentimentSentiment ClassificationTEPText Translation(eng-fa)WikipediaCorpusCorpusPersianTweetsCorpusall datasets are iterator and can be used like below:fromdadmatools.datasetsimportFarsTailfromdadmatools.datasetsimportSnappfoodSentimentfromdadmatools.datasetsimportPeymafromdadmatools.datasetsimportPerUDTfromdadmatools.datasetsimportPersianTweetsfromdadmatools.datasetsimportPnSummaryfarstail=FarsTail()#len of datasetprint(len(farstail.train))#like a generatorprint(next(farstail.train))#dataset detailspn_summary=PnSummary()print('PnSummary dataset information: ',pn_summary.info)#loop over datasetsnpfood_sa=SnappfoodSentiment()fori,iteminenumerate(snpfood_sa.test):print(item['comment'],item['label'])#get first tokens' lemma of all dev itemsperudt=PerUDT()fortoken_listinperudt.dev:print(token_list[0]['lemma'])#get NER tag of first Peyma's datapeyma=Peyma()print(next(peyma.data)[0]['tag'])#corpustweets=PersianTweets()print('tweets count : ',len(tweets.data))print('sample tweet: ',next(tweets.data))get dataset info:fromdadmatools.datasetsimportget_all_datasets_infoget_all_datasets_info().keys()#dict_keys(['Persian-NEWS', 'fa-wiki', 'faspell', 'PnSummary', 'TEP', 'PerUDT', 'FarsTail', 'Peyma', 'snappfoodSentiment', 'Persian-NER', 'Arman', 'PerSent'])#specify taskget_all_datasets_info(tasks=['NER','Sentiment-Analysis'])the output will be:{"ARMAN":{"description":"ARMAN dataset holds 7,682 sentences with 250,015 sentences tagged over six different classes.\n\nOrganization\nLocation\nFacility\nEvent\nProduct\nPerson","filenames":["train_fold1.txt","train_fold2.txt","train_fold3.txt","test_fold1.txt","test_fold2.txt","test_fold3.txt"],"name":"ARMAN","size":{"test":7680,"train":15361},"splits":["train","test"],"task":"NER","version":"1.0.0"},"PersianNer":{"description":"source: https://github.com/Text-Mining/Persian-NER","filenames":["Persian-NER-part1.txt","Persian-NER-part2.txt","Persian-NER-part3.txt","Persian-NER-part4.txt","Persian-NER-part5.txt"],"name":"PersianNer","size":976599,"splits":[],"task":"NER","version":"1.0.0"},"Peyma":{"description":"source: http://nsurl.org/2019-2/tasks/task-7-named-entity-recognition-ner-for-farsi/","filenames":["peyma/600K","peyma/300K"],"name":"Peyma","size":10016,"splits":[],"task":"NER","version":"1.0.0"},"snappfoodSentiment":{"description":"source: https://huggingface.co/HooshvareLab/bert-fa-base-uncased-sentiment-snappfood","filenames":["snappfood/train.csv","snappfood/test.csv","snappfood/dev.csv"],"name":"snappfoodSentiment","size":{"dev":6274,"test":6972,"train":56516},"splits":["train","test","dev"],"task":"Sentiment-Analysis","version":"1.0.0"}}Loading Persian Word EmbeddingsTo start using embedding please install fasttext:pip install fasttextdownload, load and use some pre-trained Persian word embeddings.dadmatools supports all glove, fasttext, and word2vec formats.fromdadmatools.embeddingsimportget_embedding,get_all_embeddings_info,get_embedding_infofrompprintimportpprintpprint(get_all_embeddings_info())#get embedding information of specific embeddingembedding_info=get_embedding_info('glove-wiki')#### load embedding ####word_embedding=get_embedding('glove-wiki')#get vector of the wordprint(word_embedding['سلام'])#vocabvocab=word_embedding.get_vocab()### some useful functions ###print(word_embedding.top_nearest("زمستان",10))print(word_embedding.similarity('کتب','کتاب'))print(word_embedding.embedding_text('امروز هوای خوبی بود'))The following word embeddings are currently supported:NameEmbedding AlgorithmCorpusglove-wikigloveWikipediafasttext-commoncrawl-binfasttextCommonCrawlfasttext-commoncrawl-vecfasttextCommonCrawlword2vec-conllword2vecPersian CoNLL17 corpusEvaluationWe have compared our pos tagging, dependancy parsing, and lemmatization models tostanzaandhazm.PerDT (F1 score)ToolkitPOS Tagger (UPOS)Dependancy Parser (UAS/LAS)LemmatizerDadmaTools97.52%95.36%/92.54%99.14%stanza97.35%93.34%  /  91.05%98.97%hazm--89.01%Seraji (F1 score)ToolkitPOS Tagger (UPOS)Dependancy Parser (UAS/LAS)LemmatizerDadmaTools97.83%92.5%/89.23%-stanza97.43%87.20% /  83.89%-hazm--86.93%Tehran university tree bank (F1 score)ToolkitConstituency ParserDadmaTools (without preprocess))82.88%Stanford (with some preprocess on POS tags)80.28How to useYou can see the codes and the output in colab.Cite@inproceedings{etezadi-etal-2022-dadmatools,
    title = "{D}adma{T}ools: Natural Language Processing Toolkit for {P}ersian Language",
    author = "Etezadi, Romina  and
      Karrabi, Mohammad  and
      Zare, Najmeh  and
      Sajadi, Mohamad Bagher  and
      Pilehvar, Mohammad Taher",
    booktitle = "Proceedings of the 2022 Conference of the North American Chapter of the Association for Computational Linguistics: Human Language Technologies: System Demonstrations",
    month = jul,
    year = "2022",
    address = "Hybrid: Seattle, Washington + Online",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2022.naacl-demo.13",
    pages = "124--130",
    abstract = "We introduce DadmaTools, an open-source Python Natural Language Processing toolkit for the Persian language. The toolkit is a neural pipeline based on spaCy for several text processing tasks, including normalization, tokenization, lemmatization, part-of-speech, dependency parsing, constituency parsing, chunking, and ezafe detecting. DadmaTools relies on fine-tuning of ParsBERT using the PerDT dataset for most of the tasks. Dataset module and embedding module are included in DadmaTools that support different Persian datasets, embeddings, and commonly used functions for them. Our evaluations show that DadmaTools can attain state-of-the-art performance on multiple NLP tasks. The source code is freely available at https://github.com/Dadmatech/DadmaTools.",
}