o  hJK@spddlmZmZddlmZmZGdddeZGdddeZGdddZGd d d eZ Gd d d Z d S))ABCabstractmethod)ListOptionalc@sveZdZdZddZddZeddZedefd d Z edefd d Z ed dZ eddZ edddZ dS) ConstraintayAbstract base class for all constraints that can be applied during generation. It must define how the constraint can be satisfied. All classes that inherit Constraint must follow the requirement that ```py completed = False while not completed: _, completed = constraint.update(constraint.advance()) ``` will always terminate (halt). cCs |dSN)testselfr |/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/transformers/generation/beam_constraints.py__init__s zConstraint.__init__cCszd}d}|s1|dkr||}||std||\}}}|d7}|dkr/td|r|dkr;tddS) zJ Tests whether this constraint has been properly defined. rFz[Custom Constraint is not defined correctly. self.does_advance(self.advance()) must be true.i'z)update() does not fulfill the constraint.z+Custom Constraint is not defined correctly.N)resetadvance does_advance Exceptionupdate remaining)r counter completedrsteppedrr r r rs$  zConstraint.testcCt|jd)a When called, returns the token(s) that would take this constraint one step closer to being fulfilled. Return: token_ids (Union[int, List[int], None]): - A single token ID (int) that advances the constraint, or - A list of token IDs that could advance the constraint - None if the constraint is completed or cannot be advanced H is an abstract class. Only classes inheriting this class can be called.NotImplementedError __class__r r r r r0 zConstraint.advancetoken_idcCr)zK Reads in a token and returns whether it creates progress. rrr rr r r r? zConstraint.does_advancecCr)a Reads in a token and returns booleans that indicate the progress made by it. This function will update the state of this object unlikes `does_advance(self, token_id: int)`. This isn't to test whether a certain token will advance the progress; it's to update its state as if it has been generated. This becomes important if token_id != desired token (refer to else statement in PhrasalConstraint) Args: token_id(`int`): The id of a newly generated token in the beam search. Return: stepped(`bool`): Whether this constraint has become one step closer to being fulfuilled. completed(`bool`): Whether this constraint has been completely fulfilled by this token being generated. reset (`bool`): Whether this constraint has reset its progress by this token being generated. rrrr r r rHs zConstraint.updatecCr)z Resets the state of this constraint to its initialization. We would call this in cases where the fulfillment of a constraint is abrupted by an unwanted token. rrr r r r ras zConstraint.resetcCr)zl Returns the number of remaining steps of `advance()` in order to complete this constraint. rrr r r r rkr zConstraint.remainingFcCr)a  Creates a new instance of this constraint. Args: stateful(`bool`): Whether to not only copy the constraint for new instance, but also its state. Return: constraint(`Constraint`): The same constraint as the one being called from. rr)r statefulr r r copytrzConstraint.copyNF)__name__ __module__ __qualname____doc__r rrrintrrrrr"r r r r rs    rcsheZdZdZdeeffdd ZddZdefdd Zdefd d Z d d Z ddZ dddZ Z S)PhrasalConstraintz [`Constraint`] enforcing that an ordered sequence of tokens is included in the output. Args: token_ids (`List[int]`): The id of the token that must be generated by the output. token_idscsxtt|t|trt|dkrtd|dtdd|Dr+td|d||_t|j|_ d|_ d|_ dS) Nrz/`token_ids` has to be a non-empty list, but is .cs$|] }t|t p |dkVqdSrN isinstancer(.0rr r r "z-PhrasalConstraint.__init__..zGEach list in `token_ids` has to be a list of positive integers, but is F) superrr r/listlen ValueErroranyr*seqlen fulfilled_idxr)r r*rr r r s  zPhrasalConstraint.__init__cCs|jrdS|j|jdSNr)rr*r;r r r r rszPhrasalConstraint.advancercCs@t|tstd|dt||jrdS||j|jdkS)N&`token_id` has to be an `int`, but is of type Fr)r/r( TypeErrortyperr*r;rr r r rs zPhrasalConstraint.does_advancecCs|t|tstd|dt|d}d}d}||r3|jd7_d}|j|jdkr/d}||_nd}||||fS)Nr>r?FrT) r/r(r@rArr;r:rrr rrrrr r r rs   zPhrasalConstraint.updatecCsd|_d|_dS)NFr)rr;r r r r r zPhrasalConstraint.resetcCs|j|jdSr=)r:r;r r r r rszPhrasalConstraint.remainingFcC*t|j}|r|j|_|j|_|j|_|Sr)r)r*r:seq_lenr;rr r!new_constraintr r r r" zPhrasalConstraint.copyr#r$r%r&r'rr(r rrrrrr" __classcell__r r r<r r)s r)c@sDeZdZddeeefddZddZddZd d Zd d Z d S)DisjunctiveTrieTnested_token_idscCsztdd|D|_i}|D]}|}t|D]\}}||vr"i||<||}qq|r8|||r8td|d||_dS)ze A helper class that builds a trie with the words represented in `nested_token_ids`. cSsg|]}t|qSr )r7)r1oner r r z,DisjunctiveTrie.__init__..zSEach list in `nested_token_ids` can't be a complete subset of another list, but is r+N)max max_height enumerate has_subsetsr8trie)r rL no_subsetsrootr*leveltidxrr r r r s   zDisjunctiveTrie.__init__cCs(|j}|D]}||}qt|}|S)z~ The next possible tokens that will progress the trie, given the current sequence of tokens in `current_seq`. )rTr6keys)r current_seqstart current_token next_tokensr r r r]s   zDisjunctiveTrie.next_tokenscCs||}t|dkSNr)r]r7)r rZr]r r r reached_leafs  zDisjunctiveTrie.reached_leafcs2t|}t|dkrdStfdd|DS)Nrrcsg|]}|qSr ) count_leaves)r1nnr r r rNsz0DisjunctiveTrie.count_leaves..)r6valuesr7sum)r rV next_nodesr r r r`s  zDisjunctiveTrie.count_leavescCs||}t||kS)zh Returns whether # of leaves == # of words. Otherwise some word is a subset of another. )r`r7)r rTrL leaf_countr r r rSs  zDisjunctiveTrie.has_subsetsNT) r$r%r&rr(r r]r_r`rSr r r r rKs   rKcsleZdZdZdeeeffdd ZddZdefdd Zdefd d Z d d Z ddZ dddZ Z S)DisjunctiveConstrainta3 A special [`Constraint`] that is fulfilled by fulfilling just one of several constraints. Args: nested_token_ids (`List[List[int]]`): A list of words, where each word is a list of ids. This constraint is fulfilled by generating just one from the list of words. rLcstt|t|trt|dkrtd|dtdd|Dr+td|dtdd|Dr.z5`nested_token_ids` has to be a list of lists, but is css"|] }tdd|DVqdS)csr,r-r.r0r r r r2r3z;DisjunctiveConstraint.__init__...N)r9rhr r r r2s  zNEach list in `nested_token_ids` has to be a list of positive integers, but is F)r5rr r/r6r7r8r9rKrTr*rQr:rZr)r rLr<r r r s     zDisjunctiveConstraint.__init__cCs"|j|j}t|dkrdS|Sr^)rTr]rZr7)r token_listr r r r(s zDisjunctiveConstraint.advancercCs8t|tstd|dt||j|j}||vS)N0`token_id` is supposed to be type `int`, but is r?)r/r(r@rArTr]rZ)r rr]r r r r0s z"DisjunctiveConstraint.does_advancecCstt|tstd|dt|d}d}d}||r%|j|d}nd}||j |j}||_ |||fS)Nrjr?FT) r/r(r@rArrZappendrrTr_rrBr r r r8s    zDisjunctiveConstraint.updatecCsd|_g|_dS)NF)rrZr r r r rLrCzDisjunctiveConstraint.resetcCs|jrdS|jt|jSr^)rr:r7rZr r r r rPszDisjunctiveConstraint.remainingFcCrDr)rgr*r:rErZrrFr r r r"WrHzDisjunctiveConstraint.copyr#rIr r r<r rgs rgc@sheZdZdZdeefddZddZddZd d Z d e ee fd d Z de fddZ dddZdS)ConstraintListStatez A class for beam scorers to track its progress through a list of constraints. Args: constraints (`List[Constraint]`): A list of [`Constraint`] objects that must be fulfilled by the beam scorer. constraintscCs6||_tdd|D|_t||_d|_|dS)NcSsg|]}|jqSr )r:)r1cr r r rNosz0ConstraintListState.__init__..F)rmrP max_seqlenr7 n_constraintsr init_state)r rmr r r r ks   zConstraintListState.__init__cCs"g|_d|_dd|jD|_dS)NcSg|]}|jddqS)Fr!r"r1 constraintr r r rNxsz2ConstraintListState.init_state..)complete_constraintsinprogress_constraintrmpending_constraintsr r r r rquszConstraintListState.init_statecCs2d}|jr||j|j7}t|j|j|Sr^)rxrorr7rw)r addr r r get_bankzszConstraintListState.get_bankcCsg}|jdur'|jD]}|}t|tr||q t|tr%||q n|j}t|tr7||n t|trA||t|dkrIdS|S)aThe list of tokens to generate such that we can make progress. By "list" we don't mean the list of token that will fully fulfill a constraint. Given constraints `c_i = {t_ij | j == # of tokens}`, If we're not in the middle of progressing through a specific constraint `c_i`, we return: `[t_k1 for k in indices of unfulfilled constraints]` If we are in the middle of a constraint, then we return: `[t_ij]`, where `i` is the index of the inprogress constraint, `j` is the next step for the constraint. Though we don't care which constraint is fulfilled first, if we are in the progress of fulfilling a constraint, that's the only one we'll return. Nr) rxryrr/r(rkr6extendr7)r rirvrr r r rs$            zConstraintListState.advancer*cCs<||dur|D]}||\}}|jrdSq dSdS)zr token_ids: the tokens generated thus far to reset the state of the progress through constraints. N)rqrzr)r r*tokencompleterr r r rszConstraintListState.resetrcCs`t|ts td|dd\}}|jrd}d}||fS|jdurT|j|\}}}|r:|j|jjddd|_|rP|j |jd|_t |jdkrPd|_||fSt |jD]R\}}| |r||\}}}|spt d|r{|j |d|_|s|r||_|s|r|jd||j|d d|_t |jdkr|jdurd|_||fSqY||fS) Nz'`token_id` should be an `int`, but is `z`.)FFTFrsrz|`constraint.update(token_id)` is not yielding incremental progress, even though `constraint.does_advance(token_id)` is true.r)r/r(r@rrxrryrkr"rwr7rRrr)r rr~rrcidxpending_constraintr r r rzsN  &  zConstraintListState.addTcCsPt|j}|r&dd|jD|_|jdur|jjdd|_dd|jD|_|S)NcSrr)Trsrtrur r r rNs z,ConstraintListState.copy..TrscSsg|]}|qSr rtrur r r rN rO)rlrmrwrxr"ry)r r! new_stater r r r"s  zConstraintListState.copyNrf)r$r%r&r'rrr rqr{rrr(rrzr"r r r r rlbs #LrlN) abcrrtypingrrrr)rKrgrlr r r r sK9Z