Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Fix coding style in dspy/predict (#8179)

Chen Qianfa69844ccc90
diff --git a/dspy/predict/__init__.py b/dspy/predict/__init__.py
index e57615587..00fd80d76 100644
--- a/dspy/predict/__init__.py
+++ b/dspy/predict/__init__.py
@@ -4,11 +4,11 @@ from dspy.predict.chain_of_thought import ChainOfThought
from dspy.predict.chain_of_thought_with_hint import ChainOfThoughtWithHint
from dspy.predict.knn import KNN
from dspy.predict.multi_chain_comparison import MultiChainComparison
+from dspy.predict.parallel import Parallel
from dspy.predict.predict import Predict
from dspy.predict.program_of_thought import ProgramOfThought
from dspy.predict.react import ReAct, Tool
from dspy.predict.refine import Refine
-from dspy.predict.parallel import Parallel
__all__ = [
"majority",
diff --git a/dspy/predict/aggregation.py b/dspy/predict/aggregation.py
index c65badd0a..9d56d3810 100644
--- a/dspy/predict/aggregation.py
+++ b/dspy/predict/aggregation.py
@@ -1,15 +1,16 @@
from dspy.dsp.utils import normalize_text
from dspy.primitives.prediction import Completions, Prediction
+
def default_normalize(s):
return normalize_text(s) or None
def majority(prediction_or_completions, normalize=default_normalize, field=None):
"""
- Returns the most common completion for the target field (or the last field) in the signature.
- When normalize returns None, that completion is ignored.
- In case of a tie, earlier completion are prioritized.
+ Returns the most common completion for the target field (or the last field) in the signature.
+ When normalize returns None, that completion is ignored.
+ In case of a tie, earlier completion are prioritized.
"""
assert any(isinstance(prediction_or_completions, t) for t in [Prediction, Completions, list])
@@ -20,12 +21,12 @@ def majority(prediction_or_completions, normalize=default_normalize, field=None)
completions = prediction_or_completions.completions
else:
completions = prediction_or_completions
-
+
try:
signature = completions.signature
except Exception:
signature = None
-
+
if not field:
if signature:
field = list(signature.output_fields.keys())[-1]
@@ -36,10 +37,10 @@ def majority(prediction_or_completions, normalize=default_normalize, field=None)
normalize = normalize if normalize else lambda x: x
normalized_values = [normalize(completion[field]) for completion in completions]
normalized_values_ = [x for x in normalized_values if x is not None]
-
+
# Count
value_counts = {}
- for value in (normalized_values_ or normalized_values):
+ for value in normalized_values_ or normalized_values:
value_counts[value] = value_counts.get(value, 0) + 1
majority_value = max(value_counts, key=value_counts.get)
@@ -48,8 +49,6 @@ def majority(prediction_or_completions, normalize=default_normalize, field=None)
for completion in completions:
if normalize(completion[field]) == majority_value:
break
-
+
# if input_type == Prediction:
return Prediction.from_completions([completion], signature=signature)
-
-
diff --git a/dspy/predict/avatar/avatar.py b/dspy/predict/avatar/avatar.py
index 7b7f56001..53142d21c 100644
--- a/dspy/predict/avatar/avatar.py
+++ b/dspy/predict/avatar/avatar.py
@@ -1,11 +1,11 @@
-import dspy
-
from copy import deepcopy
+
from pydantic.fields import FieldInfo
+import dspy
+from dspy.predict.avatar.models import Action, ActionOutput, Tool
from dspy.predict.avatar.signatures import Actor
from dspy.signatures.signature import ensure_signature
-from dspy.predict.avatar.models import Action, ActionOutput, Tool
def get_number_with_suffix(number: int) -> str:
@@ -53,29 +53,25 @@ class Avatar(dspy.Module):
self.actor_clone = deepcopy(self.actor)
-
def _get_field(self, field_info: FieldInfo):
- if field_info.json_schema_extra['__dspy_field_type'] == 'input':
+ if field_info.json_schema_extra["__dspy_field_type"] == "input":
return dspy.InputField(
- prefix=field_info.json_schema_extra['prefix'],
- desc=field_info.json_schema_extra['desc'],
- format=field_info.json_schema_extra['format'] if 'format' in field_info.json_schema_extra else None,
+ prefix=field_info.json_schema_extra["prefix"],
+ desc=field_info.json_schema_extra["desc"],
+ format=field_info.json_schema_extra["format"] if "format" in field_info.json_schema_extra else None,
)
- elif field_info.json_schema_extra['__dspy_field_type'] == 'output':
+ elif field_info.json_schema_extra["__dspy_field_type"] == "output":
return dspy.OutputField(
- prefix=field_info.json_schema_extra['prefix'],
- desc=field_info.json_schema_extra['desc'],
- format=field_info.json_schema_extra['format'] if 'format' in field_info.json_schema_extra else None,
+ prefix=field_info.json_schema_extra["prefix"],
+ desc=field_info.json_schema_extra["desc"],
+ format=field_info.json_schema_extra["format"] if "format" in field_info.json_schema_extra else None,
)
else:
raise ValueError(f"Unknown field type: {field_info.json_schema_extra['__dspy_field_type']}")
-
def _update_signature(self, idx: int, omit_action: bool = False):
self.actor.signature = self.actor.signature.with_updated_fields(
- f"action_{idx}",
- Action,
- __dspy_field_type="input"
+ f"action_{idx}", Action, __dspy_field_type="input"
)
self.actor.signature = self.actor.signature.append(
@@ -84,9 +80,9 @@ class Avatar(dspy.Module):
prefix=f"Result {idx}:",
desc=f"{get_number_with_suffix(idx)} result",
type_=str,
- )
+ ),
)
-
+
if omit_action:
for field in list(self.output_fields.keys()):
self.actor.signature = self.actor.signature.append(
@@ -94,39 +90,37 @@ class Avatar(dspy.Module):
self._get_field(self.output_fields[field]),
type_=self.output_fields[field].annotation,
)
- else:
+ else:
self.actor.signature = self.actor.signature.append(
f"action_{idx+1}",
dspy.OutputField(
prefix=f"Action {idx+1}:",
desc=f"{get_number_with_suffix(idx+1)} action to taken",
- )
+ ),
)
self.actor.signature = self.actor.signature.with_updated_fields(
f"action_{idx+1}",
Action,
)
-
def _call_tool(self, tool_name: str, tool_input_query: str) -> str:
for tool in self.tools:
if tool.name == tool_name:
return tool.tool.run(tool_input_query)
-
def forward(self, **kwargs):
if self.verbose:
print("Starting the task...")
-
+
args = {
- "goal" : self.signature.__doc__,
- "tools" : [tool.name for tool in self.tools],
+ "goal": self.signature.__doc__,
+ "tools": [tool.name for tool in self.tools],
}
-
+
for key in self.input_fields.keys():
if key in kwargs:
args[key] = kwargs[key]
-
+
idx = 1
tool_name = None
action_results: list[ActionOutput] = []
@@ -145,11 +139,7 @@ class Avatar(dspy.Module):
if tool_name != "Finish":
tool_output = self._call_tool(tool_name, tool_input_query)
action_results.append(
- ActionOutput(
- tool_name=tool_name,
- tool_input_query=tool_input_query,
- tool_output=tool_output
- )
+ ActionOutput(tool_name=tool_name, tool_input_query=tool_input_query, tool_output=tool_output)
)
self._update_signature(idx)
diff --git a/dspy/predict/avatar/models.py b/dspy/predict/avatar/models.py
index 63b43f11c..ca40baa82 100644
--- a/dspy/predict/avatar/models.py
+++ b/dspy/predict/avatar/models.py
@@ -1,4 +1,5 @@
from typing import Any, Optional
+
from pydantic import BaseModel, Field
@@ -23,4 +24,4 @@ class Action(BaseModel):
class ActionOutput(BaseModel):
tool_name: str
tool_input_query: str
- tool_output: str
\ No newline at end of file
+ tool_output: str
diff --git a/dspy/predict/avatar/signatures.py b/dspy/predict/avatar/signatures.py
index 20b3a4a5e..65d114752 100644
--- a/dspy/predict/avatar/signatures.py
+++ b/dspy/predict/avatar/signatures.py
@@ -5,9 +5,9 @@ from dspy.predict.avatar.models import Action
class Actor(dspy.Signature):
"""You will be given `Tools` which will be a list of tools to use to accomplish the `Goal`. Given the user query, your task is to decide which tool to use and what input values to provide.
-You will output action needed to accomplish the `Goal`. `Action` should have a tool to use and the input query to pass to the tool.
+ You will output action needed to accomplish the `Goal`. `Action` should have a tool to use and the input query to pass to the tool.
-Note: You can opt to use no tools and provide the final answer directly. You can also one tool multiple times with different input queries if applicable."""
+ Note: You can opt to use no tools and provide the final answer directly. You can also one tool multiple times with different input queries if applicable."""
goal: str = dspy.InputField(
prefix="Goal:",
diff --git a/dspy/predict/best_of_n.py b/dspy/predict/best_of_n.py
index 3b478c04a..f2635dcb6 100644
--- a/dspy/predict/best_of_n.py
+++ b/dspy/predict/best_of_n.py
@@ -1,16 +1,14 @@
from typing import Callable, Optional
import dspy
-from dspy.predict.predict import Prediction
-
-from dspy.predict.predict import Module
+from dspy.predict.predict import Module, Prediction
class BestOfN(Module):
def __init__(
self,
module: Module,
- N: int,
+ N: int, # noqa: N803
reward_fn: Callable[[dict, Prediction], float],
threshold: float,
fail_count: Optional[int] = None,
diff --git a/dspy/predict/chain_of_thought_with_hint.py b/dspy/predict/chain_of_thought_with_hint.py
index d7856806f..dd6ca3604 100644
--- a/dspy/predict/chain_of_thought_with_hint.py
+++ b/dspy/predict/chain_of_thought_with_hint.py
@@ -1,16 +1,18 @@
import dspy
+
from .predict import Module
+
class ChainOfThoughtWithHint(Module):
def __init__(self, signature, rationale_type=None, **config):
self.signature = dspy.ensure_signature(signature)
self.module = dspy.ChainOfThought(signature, rationale_type=rationale_type, **config)
-
+
def forward(self, **kwargs):
- if 'hint' in kwargs and kwargs['hint']:
+ if kwargs.get("hint"):
hint = f"\n\t\t(secret hint: {kwargs.pop('hint')})"
original_kwargs = kwargs.copy()
-
+
# Convert the first field's value to string and append the hint
last_key = list(self.signature.input_fields.keys())[-1]
kwargs[last_key] = str(kwargs[last_key]) + hint
@@ -22,5 +24,5 @@ class ChainOfThoughtWithHint(Module):
dspy.settings.trace.append((this_trace[0], original_kwargs, this_trace[2]))
return pred
-
+
return self.module(**kwargs)
diff --git a/dspy/predict/multi_chain_comparison.py b/dspy/predict/multi_chain_comparison.py
index f91bb0c49..10447da29 100644
--- a/dspy/predict/multi_chain_comparison.py
+++ b/dspy/predict/multi_chain_comparison.py
@@ -1,12 +1,11 @@
+from dspy.predict.predict import Predict
+from dspy.primitives.program import Module
from dspy.signatures import InputField, OutputField
from dspy.signatures.signature import ensure_signature
-from dspy.primitives.program import Module
-from dspy.predict.predict import Predict
-
class MultiChainComparison(Module):
- def __init__(self, signature, M=3, temperature=0.7, **config):
+ def __init__(self, signature, M=3, temperature=0.7, **config): # noqa: N803
super().__init__()
self.M = M
@@ -18,7 +17,8 @@ class MultiChainComparison(Module):
signature = signature.append(
f"reasoning_attempt_{idx+1}",
InputField(
- prefix=f"Student Attempt #{idx+1}:", desc="${reasoning attempt}",
+ prefix=f"Student Attempt #{idx+1}:",
+ desc="${reasoning attempt}",
),
)
@@ -36,19 +36,18 @@ class MultiChainComparison(Module):
attempts = []
for c in completions:
- rationale = c.get('rationale', c.get('reasoning')).strip().split("\n")[0].strip()
+ rationale = c.get("rationale", c.get("reasoning")).strip().split("\n")[0].strip()
answer = str(c[self.last_key]).strip().split("\n")[0].strip()
attempts.append(
f"«I'm trying to {rationale} I'm not sure but my prediction is {answer}»",
)
- assert len(attempts) == self.M, f"The number of attempts ({len(attempts)}) doesn't match the expected number M ({self.M}). Please set the correct value for M when initializing MultiChainComparison."
+ assert (
+ len(attempts) == self.M
+ ), f"The number of attempts ({len(attempts)}) doesn't match the expected number M ({self.M}). Please set the correct value for M when initializing MultiChainComparison."
kwargs = {
- **{
- f"reasoning_attempt_{idx+1}": attempt
- for idx, attempt in enumerate(attempts)
- },
+ **{f"reasoning_attempt_{idx+1}": attempt for idx, attempt in enumerate(attempts)},
**kwargs,
}
return self.predict(**kwargs)
diff --git a/dspy/predict/parallel.py b/dspy/predict/parallel.py
index 03a423524..0f7fc5833 100644
--- a/dspy/predict/parallel.py
+++ b/dspy/predict/parallel.py
@@ -1,9 +1,9 @@
import threading
-from typing import Any, List, Tuple, Optional
+from typing import Any, List, Optional, Tuple
+from dspy.dsp.utils.settings import settings
from dspy.primitives.example import Example
from dspy.utils.parallelizer import ParallelExecutor
-from dspy.dsp.utils.settings import settings
class Parallel:
diff --git a/dspy/predict/parameter.py b/dspy/predict/parameter.py
index 1c87a6919..8ed0fc020 100644
--- a/dspy/predict/parameter.py
+++ b/dspy/predict/parameter.py
@@ -1,5 +1,6 @@
class Parameter:
pass
+
class Hyperparameter:
pass
diff --git a/dspy/predict/program_of_thought.py b/dspy/predict/program_of_thought.py
index 28ade9345..891ec3dd0 100644
--- a/dspy/predict/program_of_thought.py
+++ b/dspy/predict/program_of_thought.py
@@ -1,13 +1,12 @@
+import json
import logging
import re
-from typing import Union, Type
-import json
+from typing import Type, Union
import dspy
-from dspy.signatures.signature import ensure_signature, Signature
-
from dspy.primitives.program import Module
from dspy.primitives.python_interpreter import PythonInterpreter
+from dspy.signatures.signature import Signature, ensure_signature
logger = logging.getLogger(__name__)
diff --git a/dspy/predict/react.py b/dspy/predict/react.py
index 36d8f654b..f6098672a 100644
--- a/dspy/predict/react.py
+++ b/dspy/predict/react.py
@@ -164,7 +164,7 @@ class ReAct(Module):
def _fmt_exc(err: BaseException, *, limit: int = 5) -> str:
"""
Return a one-string traceback summary.
- * `limit` – how many stack frames to keep (from the innermost outwards).
+ * `limit` - how many stack frames to keep (from the innermost outwards).
"""
import traceback
diff --git a/dspy/predict/refine.py b/dspy/predict/refine.py
index 9991750d6..3c917b508 100644
--- a/dspy/predict/refine.py
+++ b/dspy/predict/refine.py
@@ -42,7 +42,7 @@ class Refine(Module):
def __init__(
self,
module: Module,
- N: int,
+ N: int, # noqa: N803
reward_fn: Callable[[dict, Prediction], float],
threshold: float,
fail_count: Optional[int] = None,
@@ -119,7 +119,7 @@ class Refine(Module):
class WrapperAdapter(adapter.__class__):
def __call__(self, lm, lm_kwargs, signature, demos, inputs):
- inputs["hint_"] = advice.get(signature2name[signature], "N/A")
+ inputs["hint_"] = advice.get(signature2name[signature], "N/A") # noqa: B023
signature = signature.append(
"hint_", InputField(desc="A hint to the module from an earlier run")
)
@@ -144,10 +144,18 @@ class Refine(Module):
if idx == self.N - 1:
break
- modules = dict(program_code=self.module_code, modules_defn=inspect_modules(mod))
- trajectory = [dict(module_name=predictor2name[p], inputs=i, outputs=dict(o)) for p, i, o in trace]
- trajectory = dict(program_inputs=kwargs, program_trajectory=trajectory, program_outputs=dict(outputs))
- reward = dict(reward_code=self.reward_fn_code, target_threshold=self.threshold, reward_value=reward)
+ modules = {"program_code": self.module_code, "modules_defn": inspect_modules(mod)}
+ trajectory = [{"module_name": predictor2name[p], "inputs": i, "outputs": dict(o)} for p, i, o in trace]
+ trajectory = {
+ "program_inputs": kwargs,
+ "program_trajectory": trajectory,
+ "program_outputs": dict(outputs),
+ }
+ reward = {
+ "reward_code": self.reward_fn_code,
+ "target_threshold": self.threshold,
+ "reward_value": reward,
+ }
advise_kwargs = dict(**modules, **trajectory, **reward, module_names=module_names)
# advise_kwargs = {k: ujson.dumps(recursive_mask(v), indent=2) for k, v in advise_kwargs.items()}
@@ -173,7 +181,7 @@ def inspect_modules(program):
separator = "-" * 80
output = [separator]
- for idx, (name, predictor) in enumerate(program.named_predictors()):
+ for _, (name, predictor) in enumerate(program.named_predictors()):
signature = predictor.signature
instructions = textwrap.dedent(signature.instructions)
instructions = ("\n" + "\t" * 2).join([""] + instructions.splitlines())