Remove dspy.Program (#8392)

TomeHirata · web-flow · commit 5f3ebdc1cbe4 · 2025-06-18T11:01:00.000+09:00
* remove dspy.Program

* fix imports

* fix import
diff --git a/docs/docs/api/modules/Program.md b/docs/docs/api/modules/Program.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -94,7 +94,6 @@ nav:
             - MultiChainComparison: api/modules/MultiChainComparison.md
             - Parallel: api/modules/Parallel.md
             - Predict: api/modules/Predict.md
-            - Program: api/modules/Program.md
             - ProgramOfThought: api/modules/ProgramOfThought.md
             - ReAct: api/modules/ReAct.md
             - Refine: api/modules/Refine.md
diff --git a/dspy/predict/chain_of_thought.py b/dspy/predict/chain_of_thought.py
@@ -3,7 +3,7 @@
 from pydantic.fields import FieldInfo
 
 import dspy
-from dspy.primitives.program import Module
+from dspy.primitives.modules import Module
 from dspy.signatures.field import OutputField
 from dspy.signatures.signature import Signature, ensure_signature
 
diff --git a/dspy/predict/multi_chain_comparison.py b/dspy/predict/multi_chain_comparison.py
@@ -1,5 +1,5 @@
 from dspy.predict.predict import Predict
-from dspy.primitives.program import Module
+from dspy.primitives.modules import Module
 from dspy.signatures import InputField, OutputField
 from dspy.signatures.signature import ensure_signature
 
diff --git a/dspy/predict/predict.py b/dspy/predict/predict.py
@@ -8,8 +8,8 @@
 from dspy.clients.lm import LM
 from dspy.dsp.utils.settings import settings
 from dspy.predict.parameter import Parameter
+from dspy.primitives.modules import Module
 from dspy.primitives.prediction import Prediction
-from dspy.primitives.program import Module
 from dspy.signatures.signature import ensure_signature
 
 logger = logging.getLogger(__name__)
diff --git a/dspy/predict/program_of_thought.py b/dspy/predict/program_of_thought.py
@@ -4,7 +4,7 @@
 from typing import Optional, Type, Union
 
 import dspy
-from dspy.primitives.program import Module
+from dspy.primitives.modules import Module
 from dspy.primitives.python_interpreter import PythonInterpreter
 from dspy.signatures.signature import Signature, ensure_signature
 
diff --git a/dspy/predict/react.py b/dspy/predict/react.py
@@ -5,7 +5,7 @@
 
 import dspy
 from dspy.adapters.types.tool import Tool
-from dspy.primitives.program import Module
+from dspy.primitives.modules import Module
 from dspy.signatures.signature import ensure_signature
 
 logger = logging.getLogger(__name__)
diff --git a/dspy/primitives/__init__.py b/dspy/primitives/__init__.py
@@ -1,15 +1,14 @@
+from dspy.primitives.base_module import BaseModule
 from dspy.primitives.example import Example
-from dspy.primitives.module import BaseModule
+from dspy.primitives.modules import Module
 from dspy.primitives.prediction import Completions, Prediction
-from dspy.primitives.program import Module, Program
 from dspy.primitives.python_interpreter import PythonInterpreter
 
 __all__ = [
     "Example",
     "BaseModule",
     "Prediction",
     "Completions",
-    "Program",
     "Module",
     "PythonInterpreter",
 ]
diff --git a/dspy/primitives/base_module.py b/dspy/primitives/base_module.py
diff --git a/dspy/primitives/modules.py b/dspy/primitives/modules.py
@@ -1,3 +1,4 @@
+# TODO: Rename to module.py
 import inspect
 import logging
 from typing import Optional
@@ -6,7 +7,7 @@
 
 from dspy.dsp.utils.settings import settings, thread_local_overrides
 from dspy.predict.parallel import Parallel
-from dspy.primitives.module import BaseModule
+from dspy.primitives.base_module import BaseModule
 from dspy.utils.callback import with_callbacks
 from dspy.utils.inspect_history import pretty_print_history
 from dspy.utils.usage_tracker import track_usage
@@ -178,6 +179,3 @@ def __getattribute__(self, name):
 
 def set_attribute_by_name(obj, name, value):
     magicattr.set(obj, name, value)
-
-
-Program = Module
diff --git a/dspy/streaming/streamify.py b/dspy/streaming/streamify.py
@@ -21,7 +21,7 @@
 logger = logging.getLogger(__name__)
 
 if TYPE_CHECKING:
-    from dspy.primitives.program import Module
+    from dspy.primitives.modules import Module
 
 
 def streamify(
diff --git a/dspy/streaming/streaming_listener.py b/dspy/streaming/streaming_listener.py
@@ -11,7 +11,7 @@
 from dspy.streaming.messages import StreamResponse
 
 if TYPE_CHECKING:
-    from dspy.primitives.program import Module
+    from dspy.primitives.modules import Module
 
 
 class StreamListener:
diff --git a/dspy/teleprompt/bettertogether.py b/dspy/teleprompt/bettertogether.py
@@ -4,7 +4,7 @@
 
 import dspy
 from dspy.primitives.example import Example
-from dspy.primitives.program import Program
+from dspy.primitives.modules import Module
 from dspy.teleprompt.bootstrap_finetune import (
     BootstrapFinetune,
     all_predictors_have_lms,
@@ -52,11 +52,11 @@ def __init__(self,
 
     def compile(
         self,
-        student: Program,
+        student: Module,
         trainset: List[Example],
         strategy: str = "p -> w -> p",
         valset_ratio = 0.1,
-    ) -> Program:
+    ) -> Module:
         # TODO: We could record acc on a different valset to pick the best
         # strategy within the provided strategy
         logger.info("Validating the strategy")
@@ -83,7 +83,7 @@ def compile(
         logger.info("BetterTogether has finished compiling the student program")
         return student
 
-    def _run_strategies(self, parsed_strategy, student, trainset, valset_ratio) -> Program:
+    def _run_strategies(self, parsed_strategy, student, trainset, valset_ratio) -> Module:
         # Keep track of all the partial strategies/programs in parsed_strategy
         # "" corresponds to the initial student program
         candidate_programs = []
@@ -122,7 +122,7 @@ def _run_strategies(self, parsed_strategy, student, trainset, valset_ratio) -> P
         student.candidate_programs = candidate_programs
         return student
 
-    def _compile_prompt_optimizer(self, student, trainset, valset_ratio) -> Program:
+    def _compile_prompt_optimizer(self, student, trainset, valset_ratio) -> Module:
         logger.info("Preparing for prompt optimization...")
 
         # Sampling a validation set from the trainset for the prompt optimizer
@@ -148,7 +148,7 @@ def _compile_prompt_optimizer(self, student, trainset, valset_ratio) -> Program:
 
         return student
 
-    def _compile_weight_optimizer(self, student, trainset) -> Program:
+    def _compile_weight_optimizer(self, student, trainset) -> Module:
         logger.info("Preparing for weight optimization...")
 
         # Saving the LMs before compiling the weight optimizer
diff --git a/dspy/teleprompt/bootstrap_finetune.py b/dspy/teleprompt/bootstrap_finetune.py
@@ -12,7 +12,7 @@
 from dspy.evaluate.evaluate import Evaluate
 from dspy.predict.predict import Predict
 from dspy.primitives.example import Example
-from dspy.primitives.program import Program
+from dspy.primitives.modules import Module
 from dspy.teleprompt.teleprompt import Teleprompter
 from dspy.utils.exceptions import AdapterParseError
 
@@ -60,8 +60,8 @@ def __init__(
         self.num_threads = num_threads
 
     def compile(
-        self, student: Program, trainset: List[Example], teacher: Optional[Union[Program, List[Program]]] = None
-    ) -> Program:
+        self, student: Module, trainset: List[Example], teacher: Optional[Union[Module, List[Module]]] = None
+    ) -> Module:
         # TODO: Print statements can be converted to logger.info if we ensure
         # that the default DSPy logger logs info level messages in notebook
         # environments.
@@ -215,7 +215,7 @@ class FailedPrediction:
 
 
 def bootstrap_trace_data(
-    program: Program,
+    program: Module,
     dataset: List[Example],
     metric: Optional[Callable] = None,
     num_threads: Optional[int] = None,
@@ -343,20 +343,20 @@ def wrapped_program(**kwargs):
 # Note: Shared below are useful functions for preparing student/teacher programs
 # Similar methods are implemented separately and used by other DSPy
 # teleprompters. These can be moved to shared locations.
-def all_predictors_have_lms(program: Program) -> bool:
+def all_predictors_have_lms(program: Module) -> bool:
     """Return True if all predictors in the program have an LM set."""
     return all(pred.lm for pred in program.predictors())
 
 
-def copy_program_with_lms(program: Program) -> Program:
+def copy_program_with_lms(program: Module) -> Module:
     pred_lms = [pred.lm for pred in program.predictors()]
     program = program.deepcopy()
     for ind, pred in enumerate(program.predictors()):
         pred.lm = pred_lms[ind]
     return program
 
 
-def prepare_student(student: Program) -> Program:
+def prepare_student(student: Module) -> Module:
     if getattr(student, "_compiled", False):
         raise ValueError("The student program should not be compiled.")
 
@@ -368,7 +368,7 @@ def prepare_student(student: Program) -> Program:
     return student
 
 
-def prepare_teacher(student: Program, teacher: Optional[Program] = None) -> Program:
+def prepare_teacher(student: Module, teacher: Optional[Module] = None) -> Module:
     if teacher is None:
         return student
 
@@ -382,8 +382,8 @@ def prepare_teacher(student: Program, teacher: Optional[Program] = None) -> Prog
 
 
 def assert_structural_equivalency(program1: object, program2: object):
-    assert isinstance(program1, Program)
-    assert isinstance(program2, Program)
+    assert isinstance(program1, Module)
+    assert isinstance(program2, Module)
 
     num1 = len(program1.predictors())
     num2 = len(program2.predictors())
@@ -398,7 +398,7 @@ def assert_structural_equivalency(program1: object, program2: object):
         assert isinstance(pred2, Predict)
 
 
-def assert_no_shared_predictor(program1: Program, program2: Program):
+def assert_no_shared_predictor(program1: Module, program2: Module):
     id_to_name1 = {id(p): n for n, p in program1.named_predictors()}
     id_to_name2 = {id(p): n for n, p in program2.named_predictors()}
     shared_ids = set(id_to_name1.keys()) & set(id_to_name2.keys())
@@ -408,18 +408,18 @@ def assert_no_shared_predictor(program1: Program, program2: Program):
     assert not shared_ids, err
 
 
-def get_unique_lms(program: Program) -> List[LM]:
+def get_unique_lms(program: Module) -> List[LM]:
     lms = [pred.lm for pred in program.predictors()]
     return list(set(lms))
 
 
-def launch_lms(program: Program):
+def launch_lms(program: Module):
     lms = get_unique_lms(program)
     for lm in lms:
         lm.launch()
 
 
-def kill_lms(program: Program):
+def kill_lms(program: Module):
     lms = get_unique_lms(program)
     for lm in lms:
         lm.kill()
diff --git a/dspy/teleprompt/grpo.py b/dspy/teleprompt/grpo.py
@@ -10,7 +10,7 @@
 from dspy.dsp.utils.settings import settings
 from dspy.evaluate.evaluate import Evaluate
 from dspy.primitives.example import Example
-from dspy.primitives.program import Program
+from dspy.primitives.modules import Module
 from dspy.teleprompt.bootstrap_finetune import (
     FailedPrediction,
     FinetuneTeleprompter,
@@ -239,12 +239,12 @@ def select_training_sample_and_update_shuffled_trainset(
 
     def compile(
         self,
-        student: Program,
+        student: Module,
         trainset: List[Example],
-        teacher: Optional[Union[Program, List[Program]]] = None,
+        teacher: Optional[Union[Module, List[Module]]] = None,
         valset: Optional[List[Example]] = None,
         **kwargs,
-    ) -> Program:
+    ) -> Module:
         logger.info("Starting the GRPO compilation process... The LM(s) for the student program will be updated in place at the end of the training.")
         logger.info("Validating the inputs...")
 
@@ -562,7 +562,7 @@ def compile(
         return student
 
 
-def disable_lm_cache(program: Program, lm_cache_dict: dict):
+def disable_lm_cache(program: Module, lm_cache_dict: dict):
     """Disable the LM cache for all predictors in the program."""
     for pred in program.predictors():
         if not pred.lm:
@@ -572,7 +572,7 @@ def disable_lm_cache(program: Program, lm_cache_dict: dict):
         pred.lm.cache = False
 
 
-def recover_lm_cache(program: Program, lm_cache_dict: dict):
+def recover_lm_cache(program: Module, lm_cache_dict: dict):
     """Recover the LM caches for all predictors in the program to their original state."""
     for pred in program.predictors():
         if pred.lm in lm_cache_dict:
diff --git a/dspy/utils/asyncify.py b/dspy/utils/asyncify.py
@@ -4,7 +4,7 @@
 from anyio import CapacityLimiter
 
 if TYPE_CHECKING:
-    from dspy.primitives.program import Module
+    from dspy.primitives.modules import Module
 
 _limiter = None
 
diff --git a/tests/primitives/test_base_module.py b/tests/primitives/test_base_module.py
@@ -177,7 +177,7 @@ def forward(self, q):
 
 
 def test_load_with_version_mismatch(tmp_path):
-    from dspy.primitives.module import logger
+    from dspy.primitives.base_module import logger
 
     # Mock versions during save
     save_versions = {"python": "3.9", "dspy": "2.4.0", "cloudpickle": "2.0"}
@@ -205,11 +205,11 @@ def emit(self, record):
     try:
         save_path = tmp_path / "program.pkl"
         # Mock version during save
-        with patch("dspy.primitives.module.get_dependency_versions", return_value=save_versions):
+        with patch("dspy.primitives.base_module.get_dependency_versions", return_value=save_versions):
             predict.save(save_path)
 
         # Mock version during load
-        with patch("dspy.primitives.module.get_dependency_versions", return_value=load_versions):
+        with patch("dspy.primitives.base_module.get_dependency_versions", return_value=load_versions):
             loaded_predict = dspy.Predict("question->answer")
             loaded_predict.load(save_path)
 
diff --git a/tests/primitives/test_modules.py b/tests/primitives/test_modules.py
@@ -1,5 +1,6 @@
+# TODO: Rename to test_module.py
 import dspy
-from dspy.primitives.program import Module, set_attribute_by_name  # Adjust the import based on your file structure
+from dspy.primitives.modules import Module, set_attribute_by_name  # Adjust the import based on your file structure
 from dspy.utils import DummyLM
 
 
diff --git a/tests/utils/test_saving.py b/tests/utils/test_saving.py
@@ -107,7 +107,7 @@ def emit(self, record):
 
     try:
         # Mock version during save
-        with patch("dspy.primitives.module.get_dependency_versions", return_value=save_versions):
+        with patch("dspy.primitives.base_module.get_dependency_versions", return_value=save_versions):
             predict.save(tmp_path, save_program=True)
 
         # Mock version during load
