cleanup and rename

Author: NamaWho

examples/example.ipynb

@@ -716,7 +716,7 @@
     }
    ],
    "source": [
-    "from open_nuggetizer.nuggetizer import Nuggetizer\n",
+    "from pyterrier_nuggetizer.nuggetizer import Nuggetizer\n",
     "\n",
     "nuggetizer = Nuggetizer(\n",
     "    backend=backend, \n",

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools >= 61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "open_nuggetizer"
+name = "pyterrier_nuggetizer"
 description = "PyTerrier Integration of Nuggetization components"
 requires-python = ">=3.10"
 readme = "README.md"
@@ -16,16 +16,16 @@ classifiers = [
 dynamic = ["version", "dependencies"]
 
 [tool.setuptools.dynamic]
-version = {attr = "open_nuggetizer.__version__"}
+version = {attr = "pyterrier_nuggetizer.__version__"}
 dependencies = {file = ["requirements.txt"]}
 
 [tool.setuptools.packages.find]
 where = ["src"]   
 exclude = ["tests"]
 
 [project.urls]
-Repository = "https://github.com/NamaWho/open-nuggetizer"
-"Bug Tracker" = "https://github.com/NamaWho/open-nuggetizer"
+Repository = "https://github.com/NamaWho/pyterrier-nuggetizer"
+"Bug Tracker" = "https://github.com/NamaWho/pyterrier-nuggetizer"
 
 [tool.ruff]
 line-length = 120

scripts/calculate_metrics.py

@@ -4,8 +4,8 @@
 from pathlib import Path
 from typing import Dict, List
 
-from open_nuggetizer.util import load_nuggets
-from open_nuggetizer import Nuggetizer
+from pyterrier_nuggetizer.util import load_nuggets
+from pyterrier_nuggetizer import Nuggetizer
 from pyterrier_rag import VLLMBackend
 
 

scripts/create_nuggets.py

@@ -2,8 +2,8 @@
 import argparse
 
 import pyterrier as pt
-from open_nuggetizer import Nuggetizer
-from open_nuggetizer.util import save_nuggets
+from pyterrier_nuggetizer import Nuggetizer
+from pyterrier_nuggetizer.util import save_nuggets
 from pyterrier_rag import VLLMBackend
 
 

src/open_nuggetizer/__init__.py

@@ -1,6 +1,6 @@
-from open_nuggetizer.nuggetizer import Nuggetizer
-from open_nuggetizer import measure as measure
-from open_nuggetizer import prompts
+from pyterrier_nuggetizer.nuggetizer import Nuggetizer
+from pyterrier_nuggetizer import measure as measure
+from pyterrier_nuggetizer import prompts
 
 __version__ = '0.0.1'
 

src/open_nuggetizer/measure/_ir_measures.py

@@ -1,7 +1,7 @@
 import ir_measures
-from open_nuggetizer.measure._provider import NuggetEvalProvider
-import open_nuggetizer
-from open_nuggetizer.measure._util import RAGRunConverter
+from pyterrier_nuggetizer.measure._provider import NuggetEvalProvider
+import pyterrier_nuggetizer
+from pyterrier_nuggetizer.measure._util import RAGRunConverter
 
 SUPPORTED_MEASURES = {'VitalScore', 'WeightedScore', 'AllScore'}
 

src/open_nuggetizer/measure/_provider.py

@@ -1,8 +1,8 @@
 from typing import Iterator, List, Tuple
 from ir_measures import providers, Metric
 from ir_measures.providers.base import Any
-from open_nuggetizer.measure._measures import _AllScore, _VitalScore, _WeightedScore
-from open_nuggetizer.measure._util import NuggetQrelsConverter, RAGRunConverter
+from pyterrier_nuggetizer.measure._measures import _AllScore, _VitalScore, _WeightedScore
+from pyterrier_nuggetizer.measure._util import NuggetQrelsConverter, RAGRunConverter
 
 
 class NuggetScoreEvaluator(providers.Evaluator):

src/open_nuggetizer/nuggetizer.py

@@ -6,19 +6,17 @@
 from pyterrier_rag.prompt import PromptTransformer
 import pandas as pd
 
-from open_nuggetizer.measure._ir_measures import measure_factory
-from open_nuggetizer._types import NuggetAssignMode
-from open_nuggetizer.prompts import (
+from pyterrier_nuggetizer.measure._ir_measures import measure_factory
+from pyterrier_nuggetizer._types import NuggetAssignMode
+from pyterrier_nuggetizer.prompts import (
     CREATOR_PROMPT_STRING,
     SCORER_PROMPT_STRING,
     ASSIGNER_GRADE_2_PROMPT_STRING,
     ASSIGNER_GRADE_3_PROMPT_STRING,
     make_callable_template,
 )
-# from open_nuggetizer.measure._ir_measures import measure_factory
-from open_nuggetizer.measure._measures import _AllScore, _VitalScore, _WeightedScore
-from open_nuggetizer.util import iter_windows, extract_list
-# import pdb
+from pyterrier_nuggetizer.measure._measures import _AllScore, _VitalScore, _WeightedScore
+from pyterrier_nuggetizer.util import iter_windows, extract_list
 
 class Nuggetizer(pt.Transformer):
     """
@@ -111,7 +109,7 @@ def __post_init__(self):
     def make_provider(self):
         if self.provider:
             return
-        from open_nuggetizer.measure._provider import NuggetEvalProvider
+        from pyterrier_nuggetizer.measure._provider import NuggetEvalProvider
         self.provider = NuggetEvalProvider(self)
 
         from ir_measures import DefaultPipeline

src/open_nuggetizer/prompts/__init__.py

@@ -1,7 +1,7 @@
-from open_nuggetizer.prompts.assigner import ASSIGNER_GRADE_2_PROMPT_STRING, ASSIGNER_GRADE_3_PROMPT_STRING
-from open_nuggetizer.prompts.creator import CREATOR_PROMPT_STRING
-from open_nuggetizer.prompts.scorer import SCORER_PROMPT_STRING
-from open_nuggetizer.prompts._util import render_prompt, make_callable_template
+from pyterrier_nuggetizer.prompts.assigner import ASSIGNER_GRADE_2_PROMPT_STRING, ASSIGNER_GRADE_3_PROMPT_STRING
+from pyterrier_nuggetizer.prompts.creator import CREATOR_PROMPT_STRING
+from pyterrier_nuggetizer.prompts.scorer import SCORER_PROMPT_STRING
+from pyterrier_nuggetizer.prompts._util import render_prompt, make_callable_template
 
 
 __all__ = [

tests/test_assigner.py

@@ -1,8 +1,8 @@
 import pytest
 import pandas as pd
-from open_nuggetizer import Nuggetizer
-from open_nuggetizer.nuggetizer import NuggetAssigner
-from open_nuggetizer._types import NuggetAssignMode
+from pyterrier_nuggetizer import Nuggetizer
+from pyterrier_nuggetizer.nuggetizer import NuggetAssigner
+from pyterrier_nuggetizer._types import NuggetAssignMode
 
 class DummyBackendGrade2:
     def __init__(self):