[Doc PR Part 1] Necessary fixes for API reference generation

dspy/__init__.py

@@ -24,6 +24,8 @@
 configure = settings.configure
 context = settings.context
 
+BootstrapRS = BootstrapFewShotWithRandomSearch
+
 from .__metadata__ import (
     __name__,
     __version__,
@@ -32,15 +34,3 @@
     __author__,
     __author_email__
 )
-
-import dspy.teleprompt
-
-LabeledFewShot = dspy.teleprompt.LabeledFewShot
-BootstrapFewShot = dspy.teleprompt.BootstrapFewShot
-BootstrapFewShotWithRandomSearch = dspy.teleprompt.BootstrapFewShotWithRandomSearch
-BootstrapRS = dspy.teleprompt.BootstrapFewShotWithRandomSearch
-BootstrapFinetune = dspy.teleprompt.BootstrapFinetune
-BetterTogether = dspy.teleprompt.BetterTogether
-COPRO = dspy.teleprompt.COPRO
-MIPROv2 = dspy.teleprompt.MIPROv2
-Ensemble = dspy.teleprompt.Ensemble

dspy/adapters/__init__.py

@@ -2,3 +2,10 @@
 from dspy.adapters.chat_adapter import ChatAdapter
 from dspy.adapters.json_adapter import JSONAdapter
 from dspy.adapters.image_utils import Image
+
+__all__ = [
+    "Adapter",
+    "ChatAdapter",
+    "JSONAdapter",
+    "Image",
+]

dspy/clients/__init__.py

@@ -36,10 +36,10 @@ def disable_litellm_logging():
 
 
 __all__ = [
+    "BaseLM",
     "LM",
     "Provider",
     "TrainingJob",
-    "BaseLM",
     "inspect_history",
     "Embedder",
     "enable_litellm_logging",

dspy/evaluate/__init__.py

@@ -3,3 +3,13 @@
 from dspy.evaluate.metrics import answer_exact_match, answer_passage_match
 from dspy.evaluate.evaluate import Evaluate
 from dspy.evaluate.auto_evaluation import SemanticF1, CompleteAndGrounded
+
+__all__ = [
+    "EM",
+    "normalize_text",
+    "answer_exact_match",
+    "answer_passage_match",
+    "Evaluate",
+    "SemanticF1",
+    "CompleteAndGrounded",
+]

dspy/experimental/synthesizer/__init__.py

@@ -1 +1,8 @@
-from dspy.experimental.synthesizer import *
+from dspy.experimental.synthesizer.synthesizer import Synthesizer
+from dspy.experimental.synthesizer.config import SynthesizerArguments
+
+
+__all__ = [
+    "Synthesizer",
+    "SynthesizerArguments",
+]

dspy/experimental/synthesizer/synthesizer.py

@@ -7,13 +7,12 @@
 from tqdm import tqdm, trange
 
 import dspy
-
-from .config import SynthesizerArguments
-from .instruction_suffixes import (
+from dspy.experimental.synthesizer.config import SynthesizerArguments
+from dspy.experimental.synthesizer.instruction_suffixes import (
     INPUT_GENERATION_TASK_WITH_EXAMPLES_SUFFIX,
     INPUT_GENERATION_TASK_WITH_FEEDBACK_SUFFIX,
 )
-from .signatures import (
+from dspy.experimental.synthesizer.signatures import (
     ExplainTask,
     GenerateFieldDescription,
     GenerateInputFieldsData,
@@ -22,12 +21,8 @@
     UnderstandTask,
     UpdateTaskDescriptionBasedOnFeedback,
 )
-from .utils import format_examples
+from dspy.experimental.synthesizer.utils import format_examples
 
-__all__ = [
-    "Synthesizer",
-    "SynthesizerArguments",
-]
 
 class Synthesizer:
     def __init__(self, config: SynthesizerArguments):

dspy/primitives/__init__.py

@@ -3,7 +3,7 @@
 from dspy.primitives.module import BaseModule
 from dspy.primitives.prediction import Prediction, Completions
 from dspy.primitives.program import Program, Module
-from dspy.primitives.python_interpreter import PythonInterpreter, TextPrompt, CodePrompt
+from dspy.primitives.python_interpreter import PythonInterpreter
 
 
 __all__ = [
@@ -15,6 +15,4 @@
     "Program",
     "Module",
     "PythonInterpreter",
-    "TextPrompt",
-    "CodePrompt",
 ]

dspy/signatures/__init__.py

@@ -8,6 +8,7 @@
     infer_prefix,
 )
 
+
 __all__ = [
     "InputField",
     "OutputField",