divergent-beamsearch 0.1.0__py3-none-any.whl

divergent_beamsearch/__init__.py

@@ -0,0 +1 @@
+from .algorithm import divergent_beamsearch

divergent_beamsearch/algorithm.py

@@ -0,0 +1,112 @@
+import math
+import torch
+from transformers import GPT2LMHeadModel
+from multi_choices_parser import MultiChoicesParser, end_symb
+
+
+def get_parsers_tokens(parsers : list[MultiChoicesParser]) -> tuple[list, list[int]]:
+    parsers_tokens = []
+    can_end = []
+    for parser in parsers:
+        tokens = list(parser.next())
+        if end_symb in tokens:
+            can_end.append(True)
+            tokens.remove(end_symb)
+        else:
+            can_end.append(False)
+        parsers_tokens.append(tokens)
+    return parsers_tokens, can_end
+
+def apply_mask_tokens(pred : torch.Tensor, parsers_tokens):
+    mask = torch.ones_like(pred, dtype=torch.bool)
+    for tokens in parsers_tokens:
+        mask[:, tokens] = False
+    pred[mask] = -float('inf')
+    return pred[~pred.isinf().all(dim=-1)]
+
+
+def batched_inference_logits(model : GPT2LMHeadModel, input_ids : torch.Tensor, batch_size : int = 32) -> torch.Tensor:
+    logits = []
+    for i in range(0, input_ids.shape[0], batch_size):
+        logits.append(model(input_ids[i:i+batch_size]).logits)
+    return torch.cat(logits, dim=0)
+
+def select_mask(source : list, mask : list[bool]) -> list:
+    assert len(source) == len(mask)
+    return [x for x, m in zip(source, mask) if m]
+
+
+def log1mexp(x: torch.Tensor) -> torch.Tensor:
+    """Numerically accurate evaluation of log(1 - exp(x)) for x < 0.
+    See [Maechler2012accurate]_ for details.
+    """
+    mask = -math.log(2) < x  # x < 0
+    return torch.where(
+        mask,
+        (-x.expm1()).log(),
+        (-x.exp()).log1p(),
+    )
+
+@torch.no_grad()
+def divergent_beamsearch(input_ids : torch.Tensor, model : GPT2LMHeadModel, beam_size : int, max_length : int, multi_choices_parser : MultiChoicesParser, pad_token_id : int, batch_size=32, num_solutions = None) -> tuple[torch.Tensor, torch.Tensor]:
+    assert input_ids.shape[0] == 1, "Batch size must be 1"
+    
+    if num_solutions is None:
+        num_solutions = beam_size
+
+    parsers_unfinished = [multi_choices_parser]
+    scores_finished = torch.tensor([], dtype=torch.float)
+    solutions_finished = torch.tensor([], dtype=torch.long).view(0,0)
+    
+    input_ids_unfinished = input_ids
+    scores_unfinished = torch.tensor([0.0], dtype=torch.float)
+    solutions_unfinished = torch.tensor([], dtype=torch.long).view(1,0)
+
+    
+    for _ in range(max_length):
+        if len(input_ids_unfinished) == 0:
+            break
+        pred = batched_inference_logits(model, input_ids_unfinished, batch_size)[:, -1].cpu()
+        parsers_tokens, can_end = get_parsers_tokens(parsers_unfinished)
+        # input_ids_unfinished = input_ids_unfinished[~torch.tensor(can_only_end)]
+        logprobs = torch.log_softmax(pred, dim=-1)
+        logprobs_filtered = apply_mask_tokens(logprobs, parsers_tokens)
+        if len(logprobs_filtered):
+            topk = torch.topk(logprobs_filtered, beam_size, dim=-1) # shape (batch_size, beam_size)
+            topk_global = topk.values.flatten().topk(beam_size)
+            best_tokens_row = topk_global.indices // beam_size
+            best_tokens, best_tokens_logprobs = topk.indices[best_tokens_row, topk_global.indices % beam_size], topk_global.values
+            notinf = ~best_tokens_logprobs.isinf()
+            best_tokens, best_tokens_row, best_tokens_logprobs = best_tokens[notinf], best_tokens_row[notinf], best_tokens_logprobs[notinf]
+        else:
+            best_tokens = torch.tensor([], dtype=torch.long)
+            best_tokens_row = torch.tensor([], dtype=torch.long)
+            best_tokens_logprobs = torch.tensor([], dtype=torch.float)
+
+
+        scores_finished_current = scores_unfinished[can_end]
+        solutions_finished_current = solutions_unfinished[can_end]
+        scores_finished_current = scores_finished_current + log1mexp(logprobs[can_end, select_mask(parsers_tokens, can_end)].logsumexp(dim=-1)).squeeze(-1)
+        scores_finished = torch.cat([scores_finished, scores_finished_current])
+        if len(solutions_finished_current):
+            pad = torch.full((len(scores_finished_current), solutions_finished_current.shape[1] - solutions_finished.shape[1]), pad_token_id, dtype=torch.long)
+            solutions_finished = torch.cat([solutions_finished.view(-1, solutions_finished_current.shape[1]+pad.shape[1]), torch.cat([solutions_finished_current, pad], dim=1)], dim=0)
+        if solutions_finished.numel():
+            # Keep num_solutions best solutions in finished
+            order = scores_finished.argsort(descending=True)
+            solutions_finished = solutions_finished[order][:num_solutions]
+            scores_finished = scores_finished[order][:num_solutions]
+
+
+        input_ids_unfinished = torch.cat([input_ids_unfinished[best_tokens_row], best_tokens.unsqueeze(-1)], dim=-1)
+        scores_unfinished = scores_unfinished[best_tokens_row] + best_tokens_logprobs
+        solutions_unfinished = torch.cat([solutions_unfinished[best_tokens_row], best_tokens.unsqueeze(-1)], dim=-1)
+        parsers_unfinished = [parsers_unfinished[row].copy() for row in best_tokens_row]
+        for parser, token in zip(parsers_unfinished, best_tokens.tolist()):
+            parser.step(token)
+    
+    return scores_finished, solutions_finished
+        
+
+        
+        

divergent_beamsearch-0.1.0.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: divergent-beamsearch
+Version: 0.1.0
+Summary: A variant of the beam search algorithm that focuses on finding answers that maximize the probability of generating an answer before diverging into another subject.
+License-File: LICENCE
+Requires-Python: >=3.11
+Requires-Dist: multi-choices-parser>=0.9.57
+Requires-Dist: torch>=2.5.1
+Requires-Dist: transformers>=4.47.1
+Description-Content-Type: text/markdown
+
+# Divergent Beam Search
+## Overview
+
+Divergent Beam Search is a variant of the beam search algorithm. Unlike the beam search where answers are constrained, which aims to find the answers with the highest probability of appearing, Divergent Beam Search focuses on finding answers that are not likely to be continued with another answer. Essentially, it finds the answers that maximize the probability of generating an answer before diverging into another subject given the prompt.
+
+The core idea of this algorithm can be roughly summarized in the following optimization problem:
+
+$$\max_{ans \in A} P(ans + diverging\ into\ another\ subject \mid prompt)$$
+
+It is important that the set of answers $A$ is sufficiently exhaustive for this method to work. Otherwise, the algorithm could unjustifiably conclude that an answer is not being followed by the answer while this longer answer exists but is not included in the set $A$.   
+
+## Installation
+
+To install the package, use the following command:
+
+```bash
+pip install divergent-beamsearch
+```
+
+## Usage
+
+Here's a brief example of how to use `divergent-beamsearch`:
+
+```python
+import torch
+from transformers import GPT2LMHeadModel, GPT2Tokenizer
+from multi_choices_parser import MultiChoicesParser
+from divergent_beamsearch import divergent_beamsearch
+
+# Load model and tokenizer
+model = GPT2LMHeadModel.from_pretrained("gpt2")
+tokenizer = GPT2Tokenizer.from_pretrained("gpt2")
+
+# Define input prompt
+prompt = "The capital of France is"
+input_ids = tokenizer.encode(prompt, return_tensors="pt")
+
+# Define beam search parameters
+beam_size = 5
+max_length = 10
+pad_token_id = tokenizer.eos_token_id
+
+# Define possible answers
+possible_answers = [' Paris', ' Paris Hilton']
+tokenized_answers = tokenizer(possible_answers).input_ids
+multi_choices_parser = MultiChoicesParser([tokenized_answers])
+
+# Perform beam search
+scores, solutions = divergent_beamsearch(
+    input_ids=input_ids,
+    model=model,
+    beam_size=beam_size,
+    max_length=max_length,
+    multi_choices_parser=multi_choices_parser,
+    pad_token_id=pad_token_id,
+    num_solutions=2
+)
+
+# Decode solutions
+decoded_solutions = [tokenizer.decode(solution, skip_special_tokens=True) for solution in solutions]
+print("Scores:", scores)
+print("Solutions:", decoded_solutions)
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

divergent_beamsearch-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+divergent_beamsearch/__init__.py,sha256=Z2R1pkj4EEHMKWVZX0upeE_Jtfb6joxgYHuRNxWc8Zo,43
+divergent_beamsearch/algorithm.py,sha256=6cWp6XHepSn1rjqQFkASxd8k3OEUarKNAiqPKfrA78k,5324
+divergent_beamsearch-0.1.0.dist-info/METADATA,sha256=UCkp3rgFZ89kmwFVy_N_dEy45NTGN_yFhf-J6WCCR4U,2826
+divergent_beamsearch-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+divergent_beamsearch-0.1.0.dist-info/licenses/LICENCE,sha256=jDQOOFKJxgrQwcEyipwKcKzj5IX_paD_41c3iOjH3qw,1095
+divergent_beamsearch-0.1.0.dist-info/RECORD,,

divergent_beamsearch-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

divergent_beamsearch-0.1.0.dist-info/licenses/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hichem Ammar Khodja
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.