o Zh?i@sddlZddlZddlmZmZmZmZddlZddl m Z ddl m Z m Z mZmZddlmZmZmZmZerCddlZddlmZerPddlZdd lmZGd d d eZGd d d e Ze edddGdddeZeZdS)N)ListOptionalTupleUnion)BasicTokenizer) ExplicitEnumadd_end_docstringsis_tf_availableis_torch_available)ArgumentHandler ChunkPipelineDatasetbuild_pipeline_init_args)/TF_MODEL_FOR_TOKEN_CLASSIFICATION_MAPPING_NAMES),MODEL_FOR_TOKEN_CLASSIFICATION_MAPPING_NAMESc@s*eZdZdZdeeeeffddZdS)"TokenClassificationArgumentHandlerz5 Handles arguments for token classification. inputscKs|durt|ttfrt|dkrt|}t|}n"t|tr%|g}d}ntdur.t|ts4t|tjr8|dfStd| d}|r\t|trRt|dtrR|g}t||kr\td||fS)Nrr zAt least one input is required.offset_mappingz;offset_mapping should have the same batch size as the input) isinstancelisttuplelenstrrtypes GeneratorType ValueErrorget)selfrkwargsZ batch_sizerr!Z/var/www/auris/lib/python3.10/site-packages/transformers/pipelines/token_classification.py__call__ s "    z+TokenClassificationArgumentHandler.__call__N)__name__ __module__ __qualname____doc__rrrr#r!r!r!r"rsrc@s$eZdZdZdZdZdZdZdZdS)AggregationStrategyzDAll the valid aggregation strategies for TokenClassificationPipelinenonesimplefirstZaveragemaxN) r$r%r&r'NONESIMPLEFIRSTAVERAGEMAXr!r!r!r"r(5sr(T)Z has_tokenizera ignore_labels (`List[str]`, defaults to `["O"]`): A list of labels to ignore. grouped_entities (`bool`, *optional*, defaults to `False`): DEPRECATED, use `aggregation_strategy` instead. Whether or not to group the tokens corresponding to the same entity together in the predictions or not. stride (`int`, *optional*): If stride is provided, the pipeline is applied on all the text. The text is split into chunks of size model_max_length. Works only with fast tokenizers and `aggregation_strategy` different from `NONE`. The value of this argument defines the number of overlapping tokens between chunks. In other words, the model will shift forward by `tokenizer.model_max_length - stride` tokens each step. aggregation_strategy (`str`, *optional*, defaults to `"none"`): The strategy to fuse (or not) tokens based on the model prediction. - "none" : Will simply not do any aggregation and simply return raw results from the model - "simple" : Will attempt to group entities following the default schema. (A, B-TAG), (B, I-TAG), (C, I-TAG), (D, B-TAG2) (E, B-TAG2) will end up being [{"word": ABC, "entity": "TAG"}, {"word": "D", "entity": "TAG2"}, {"word": "E", "entity": "TAG2"}] Notice that two consecutive B tags will end up as different entities. On word based languages, we might end up splitting words undesirably : Imagine Microsoft being tagged as [{"word": "Micro", "entity": "ENTERPRISE"}, {"word": "soft", "entity": "NAME"}]. Look for FIRST, MAX, AVERAGE for ways to mitigate that and disambiguate words (on languages that support that meaning, which is basically tokens separated by a space). These mitigations will only work on real words, "New york" might still be tagged with two different entities. - "first" : (works only on word based models) Will use the `SIMPLE` strategy except that words, cannot end up with different tags. Words will simply use the tag of the first token of the word when there is ambiguity. - "average" : (works only on word based models) Will use the `SIMPLE` strategy except that words, cannot end up with different tags. scores will be averaged first across tokens, and then the maximum label is applied. - "max" : (works only on word based models) Will use the `SIMPLE` strategy except that words, cannot end up with different tags. Word entity will simply be the token with the maximum score.cseZdZdZdZeffdd Z      d.deedeedee d ee e e e fd ee f d d Z d eee efffdd Zd/ddZddZe jdfddZddZdedejdejd ee e e e fdejde de efddZde ede de efd d!Zd"e ede defd#d$Zd"e ede de efd%d&Zd"e edefd'd(Zd)ede eeffd*d+Zd"e ede efd,d-ZZ S)0TokenClassificationPipelineuv Named Entity Recognition pipeline using any `ModelForTokenClassification`. See the [named entity recognition examples](../task_summary#named-entity-recognition) for more information. Example: ```python >>> from transformers import pipeline >>> token_classifier = pipeline(model="Jean-Baptiste/camembert-ner", aggregation_strategy="simple") >>> sentence = "Je m'appelle jean-baptiste et je vis à montréal" >>> tokens = token_classifier(sentence) >>> tokens [{'entity_group': 'PER', 'score': 0.9931, 'word': 'jean-baptiste', 'start': 12, 'end': 26}, {'entity_group': 'LOC', 'score': 0.998, 'word': 'montréal', 'start': 38, 'end': 47}] >>> token = tokens[0] >>> # Start and end provide an easy way to highlight words in the original text. >>> sentence[token["start"] : token["end"]] ' jean-baptiste' >>> # Some models use the same idea to do part of speech. >>> syntaxer = pipeline(model="vblagoje/bert-english-uncased-finetuned-pos", aggregation_strategy="simple") >>> syntaxer("My name is Sarah and I live in London") [{'entity_group': 'PRON', 'score': 0.999, 'word': 'my', 'start': 0, 'end': 2}, {'entity_group': 'NOUN', 'score': 0.997, 'word': 'name', 'start': 3, 'end': 7}, {'entity_group': 'AUX', 'score': 0.994, 'word': 'is', 'start': 8, 'end': 10}, {'entity_group': 'PROPN', 'score': 0.999, 'word': 'sarah', 'start': 11, 'end': 16}, {'entity_group': 'CCONJ', 'score': 0.999, 'word': 'and', 'start': 17, 'end': 20}, {'entity_group': 'PRON', 'score': 0.999, 'word': 'i', 'start': 21, 'end': 22}, {'entity_group': 'VERB', 'score': 0.998, 'word': 'live', 'start': 23, 'end': 27}, {'entity_group': 'ADP', 'score': 0.999, 'word': 'in', 'start': 28, 'end': 30}, {'entity_group': 'PROPN', 'score': 0.999, 'word': 'london', 'start': 31, 'end': 37}] ``` Learn more about the basics of using a pipeline in the [pipeline tutorial](../pipeline_tutorial) This token recognition pipeline can currently be loaded from [`pipeline`] using the following task identifier: `"ner"` (for predicting the classes of tokens in a sequence: person, organisation, location or miscellaneous). The models that this pipeline can use are models that have been fine-tuned on a token classification task. See the up-to-date list of available models on [huggingface.co/models](https://huggingface.co/models?filter=token-classification). sequencescs@tj|i|||jdkrtnttdd|_||_dS)NtfF)Z do_lower_case) super__init__Zcheck_model_type frameworkrrrZ_basic_tokenizer _args_parser)rZ args_parserargsr  __class__r!r"r6s   z$TokenClassificationPipeline.__init__Ngrouped_entitiesignore_subwordsaggregation_strategyrstridec CsBi}|dur ||d<i}|dus|durA|r|rtj}n |r$|s$tj}ntj}|dur4td|d|durAtd|d|durft|trPt|}|tjtj tj hvrb|j j sbt d||d<|durn||d<|dur||j jkr|t d|tjkrt d |d |j j rd d |d } | |d <nt d|i|fS)Nrzl`grouped_entities` is deprecated and will be removed in version v5.0.0, defaulted to `aggregation_strategy="z "` instead.zk`ignore_subwords` is deprecated and will be removed in version v5.0.0, defaulted to `aggregation_strategy="z{Slow tokenizers cannot handle subwords. Please set the `aggregation_strategy` option to `"simple"` or use a fast tokenizer.r> ignore_labelszl`stride` must be less than `tokenizer.model_max_length` (or even lower if the tokenizer adds special tokens)zI`stride` was provided to process all the text but `aggregation_strategy="z&"`, please select another one instead.T)Zreturn_overflowing_tokenspaddingr?tokenizer_paramszm`stride` was provided to process all the text but you're using a slow tokenizer. Please use a fast tokenizer.)r(r/r.r-warningswarnrrupperr1r0 tokenizeris_fastrmodel_max_length) rr@r<r=r>rr?preprocess_paramsZpostprocess_paramsrBr!r!r"_sanitize_parameterssr       z0TokenClassificationPipeline._sanitize_parametersrc s6|j|fi|\}}|r||d<tj|fi|S)a Classify each token of the text(s) given as inputs. Args: inputs (`str` or `List[str]`): One or several texts (or one list of texts) for token classification. Return: A list or a list of list of `dict`: Each result comes as a list of dictionaries (one for each token in the corresponding input, or each entity if this pipeline was instantiated with an aggregation_strategy) with the following keys: - **word** (`str`) -- The token/word classified. This is obtained by decoding the selected tokens. If you want to have the exact string in the original sentence, use `start` and `end`. - **score** (`float`) -- The corresponding probability for `entity`. - **entity** (`str`) -- The entity predicted for that token/word (it is named *entity_group* when *aggregation_strategy* is not `"none"`. - **index** (`int`, only present when `aggregation_strategy="none"`) -- The index of the corresponding token in the sentence. - **start** (`int`, *optional*) -- The index of the start of the corresponding entity in the sentence. Only exists if the offsets are available within the tokenizer - **end** (`int`, *optional*) -- The index of the end of the corresponding entity in the sentence. Only exists if the offsets are available within the tokenizer r)r8r5r#)rrr Z_inputsrr:r!r"r#sz$TokenClassificationPipeline.__call__c +s|di}|jjr|jjdkrdnd}|j|f|j|d|jjd|}|ddt|d}t|D];|jdkrIfd d |D}n fd d |D}|dur\||d <dkrb|nd|d <|dk|d<|Vq6dS)NrBrTF)Zreturn_tensors truncationZreturn_special_tokens_maskZreturn_offsets_mappingZoverflow_to_sample_mapping input_idsr4cs"i|] \}}|t|dqSr)r4Z expand_dims.0kvir!r" s"z:TokenClassificationPipeline.preprocess..cs i|] \}}||dqSrM)Z unsqueezerNrRr!r"rTs rsentencer is_last)poprFrHr7rGrrangeitems) rrUrrIrBrKr num_chunks model_inputsr!rRr" preprocesss2     z&TokenClassificationPipeline.preprocesscCs|d}|dd}|d}|d}|jdkr%|jd i|d}n|jd i|}t|tr6|dn|d}|||||d|S) Nspecial_tokens_maskrrUrVr4rlogits)r^r]rrUrVr!)rWr7modelrdict)rr[r]rrUrVr^outputr!r!r"_forwards     z$TokenClassificationPipeline._forwardc s^durdgg}|D]}|jdkr,|ddjtjtjfvr,|ddtj}n|dd}|dd}|dd}|ddurL|ddnd} |dd} tj |d d d } t || } | | j d d d } |jd kr|}| dur| nd} | ||| | | |}| ||}fd d|D}||q t|}|dkr||}|S)NOptr^rrUrLrr]T)axisZkeepdimsr4cs0g|]}|ddvr|ddvr|qS)entityN entity_group)rrOrgr@r!r" Is z;TokenClassificationPipeline.postprocess..r )r7ZdtypetorchZbfloat16Zfloat16toZfloat32numpynpr,expsumgather_pre_entities aggregateextendraggregate_overlapping_entities)rZ all_outputsr>r@Z all_entitiesZ model_outputsr^rUrLrr]ZmaxesZ shifted_expscores pre_entitiesr<entitiesrZr!rjr" postprocess+s<$        z'TokenClassificationPipeline.postprocesscCst|dkr|St|ddd}g}|d}|D]A}|d|dkr*|dkrRnn&|d|d}|d|d}||krC|}q||krQ|d|dkrQ|}q|||}q|||S)NrcSs|dS)Nstartr!)xr!r!r"XszLTokenClassificationPipeline.aggregate_overlapping_entities..keyrzendscore)rsortedappend)rrxZaggregated_entitiesZprevious_entityrgZcurrent_lengthZprevious_lengthr!r!r"ruUs$ $  z:TokenClassificationPipeline.aggregate_overlapping_entitiesrUrLrvr]returncCs4g}t|D]\}} ||rq|jt||} |dur||\} } t| ts5|jdkr5| } | } || | } t|jddrTt|jjj ddrTt | t | k}n |t j t j t jhvrdtdt| dkosd|| d| dv}t|||jjkr| } d }nd} d} d }| | | | ||d }||q|S) zTFuse various numpy arrays into dicts with all the information needed for aggregationNrd _tokenizerZcontinuing_subword_prefixz?Tokenizer does not support real words, using fallback heuristicr r F)wordrvrzrindex is_subword) enumeraterFZconvert_ids_to_tokensintrr7itemgetattrrr_rr(r/r0r1rCrD UserWarningZ unk_token_idr)rrUrLrvrr]r>rwidxZ token_scoresrZ start_indZend_indZword_refr pre_entityr!r!r"rrisT        z/TokenClassificationPipeline.gather_pre_entitiesrwcCs|tjtjhvr7g}|D])}|d}|d|}|jjj|||d|d|d|dd}||q n|||}|tjkrD|S| |S)Nrvrrrzr)rgrrrrzr) r(r-r.argmaxr_configid2labelraggregate_wordsgroup_entities)rrwr>rxr entity_idxrrgr!r!r"rss$      z%TokenClassificationPipeline.aggregaterxc Cs|jdd|D}|tjkr&|dd}|}||}|jjj|}nK|tjkrGt |ddd}|d}|}||}|jjj|}n*|tj krmt dd|D}t j |dd } | } |jjj| }| | }ntd ||||dd |d d d} | S)NcSg|]}|dqSrr!rir!r!r"rkz>TokenClassificationPipeline.aggregate_word..rrvcSs |dS)Nrv)r,)rgr!r!r"r|s z.r}cSr)rvr!rir!r!r"rkr)rfzInvalid aggregation_strategyrzrer)rgrrrzr)rFconvert_tokens_to_stringr(r/rr_rrr1r,r0rostacknanmeanr) rrxr>rrvrrrgZ max_entityZaverage_scoresrZ new_entityr!r!r"aggregate_words4       z*TokenClassificationPipeline.aggregate_wordcCs|tjtjhvr tdg}d}|D] }|dur|g}q|dr&||q|||||g}q|dur@|||||S)z Override tokens from a given word that disagree to force agreement on word boundaries. Example: micro|soft| com|pany| B-ENT I-NAME I-ENT I-ENT will be rewritten with first strategy as microsoft| company| B-ENT I-ENT z;NONE and SIMPLE strategies are invalid for word aggregationNr)r(r-r.rrr)rrxr>Z word_entitiesZ word_grouprgr!r!r"rs" z+TokenClassificationPipeline.aggregate_wordscCsl|ddddd}tdd|D}dd|D}|t||j||dd |dd d }|S) z Group together the adjacent tokens with the same entity predicted. Args: entities (`dict`): The entities predicted by the pipeline. rrg-r recSr)rr!rir!r!r"rkrzBTokenClassificationPipeline.group_sub_entities..cSrrr!rir!r!r"rkrrzr)rhrrrzr)splitrormeanrFr)rrxrgrvtokensrhr!r!r"group_sub_entitiess   z.TokenClassificationPipeline.group_sub_entities entity_namecCsT|drd}|dd}||fS|dr"d}|dd}||fSd}|}||fS)NzB-BrzI-I) startswith)rrbitagr!r!r"get_tag s    z#TokenClassificationPipeline.get_tagc Csg}g}|D]7}|s||q||d\}}||dd\}}||kr2|dkr2||q||||g}q|rH||||S)z Find and group together the adjacent tokens with the same entity predicted. Args: entities (`dict`): The entities predicted by the pipeline. rgrer)rrr) rrxZ entity_groupsZentity_group_disaggrgrrZlast_biZlast_tagr!r!r"rs  z*TokenClassificationPipeline.group_entities)NNNNNN)N)!r$r%r&r'Zdefault_input_namesrr6rboolr(rrrrJrrr#r\rbr-ryruroZndarrayr`rrrsrrrrr __classcell__r!r!r:r"r2?s^#$  I * >"r2) rrCtypingrrrrrnroZmodels.bert.tokenization_bertrutilsrr r r baser rrrZ tensorflowr4Zmodels.auto.modeling_tf_autorrlZmodels.auto.modeling_autorrr(r2Z NerPipeliner!r!r!r"s0    "b