Skip to content

updated assertions error msg to specify target_module #1590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2024
Merged

updated assertions error msg to specify target_module #1590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0e057e
updated assertions error msg to specify target_module
arnavsinghvi11 Oct 7, 2024
57cb297
Update assertions.py error msg
arnavsinghvi11 Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/api/assertions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,14 @@ We can declare these validation checks through `dspy.Suggest` statements (as we
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
Copy link
Collaborator

@okhat okhat Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait I don't think we want the examples to be verbose like this. It's nice that they were implicit some of the time.

)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)
```

Expand All @@ -133,12 +135,14 @@ class SimplifiedBaleenAssertions(dspy.Module):
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)

prev_queries.append(query)
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/building-blocks/7-assertions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,14 @@ We can declare these validation checks through `dspy.Suggest` statements (as we
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)
```

Expand All @@ -131,12 +133,14 @@ class SimplifiedBaleenAssertions(dspy.Module):
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)

prev_queries.append(query)
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/deep-dive/modules/assertions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,14 @@ We can declare these validation checks through `dspy.Suggest` statements (as we
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)
```

Expand All @@ -136,12 +138,14 @@ class SimplifiedBaleenAssertions(dspy.Module):
dspy.Suggest(
len(query) <= 100,
"Query should be short and less than 100 characters",
target_module=self.generate_query
)

dspy.Suggest(
validate_query_distinction_local(prev_queries, query),
"Query should be distinct from: "
+ "; ".join(f"{i+1}) {q}" for i, q in enumerate(prev_queries)),
target_module=self.generate_query
)

prev_queries.append(query)
Expand Down
2 changes: 1 addition & 1 deletion dspy/primitives/assertions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ def wrapper(*args, **kwargs):
dspy.settings.backtrack_to = dsp.settings.trace[-1][0]

if dspy.settings.backtrack_to is None:
dspy.logger.error("Specified module not found in trace")
dspy.logger.error("Module not found in trace. If passing a DSPy Signature, please specify the intended module for the assertion (e.g., use `target_module = self.my_module(my_signature)` instead of `target_module = my_signature`).")

# save unique feedback message for predictor
if error_msg not in dspy.settings.predictor_feedbacks.setdefault(
Expand Down
2 changes: 2 additions & 0 deletions examples/qa/hotpot/hotpotqa_with_assertions.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,14 @@
" dspy.Suggest(\n",
" len(query) <= 100,\n",
" \"Query should be short and less than 100 characters\",\n",
" target_module=self.generate_query\n",
" )\n",
"\n",
" dspy.Suggest(\n",
" validate_query_distinction_local(prev_queries, query),\n",
" \"Query should be distinct from: \"\n",
" + \"; \".join(f\"{i+1}) {q}\" for i, q in enumerate(prev_queries)),\n",
" target_module=self.generate_query\n",
" )\n",
"\n",
" prev_queries.append(query)\n",
Expand Down