-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
test_functional.py
960 lines (697 loc) · 28 KB
/
test_functional.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
import datetime
import textwrap
from typing import Annotated, Any, Generic, List, Literal, Optional, TypeVar
import pydantic
import pytest
from pydantic import AfterValidator, BaseModel, Field, ValidationError, field_validator, model_validator
import dspy
from dspy.functional import FunctionalModule, TypedChainOfThought, TypedPredictor, cot, predictor
from dspy.predict.predict import Predict
from dspy.primitives.example import Example
from dspy.teleprompt.bootstrap import BootstrapFewShot
from dspy.teleprompt.vanilla import LabeledFewShot
from dspy.utils.dummies import DummyLM
def test_simple():
@predictor
def hard_question(topic: str) -> str:
"""Think of a hard factual question about a topic."""
expected = "What is the speed of light?"
lm = DummyLM([expected])
dspy.settings.configure(lm=lm)
question = hard_question(topic="Physics")
lm.inspect_history(n=2)
assert question == expected
def test_list_output():
@predictor
def hard_questions(topics: List[str]) -> List[str]:
pass
expected = ["What is the speed of light?", "What is the speed of sound?"]
lm = DummyLM(['["What is the speed of light?", "What is the speed of sound?"]'])
dspy.settings.configure(lm=lm)
question = hard_questions(topics=["Physics", "Music"])
lm.inspect_history(n=2)
assert question == expected
def test_simple_type():
class Question(pydantic.BaseModel):
value: str
@predictor
def hard_question(topic: str) -> Question:
"""Think of a hard factual question about a topic."""
expected = "What is the speed of light?"
lm = DummyLM([f'{{"value": "{expected}"}}'])
dspy.settings.configure(lm=lm)
question = hard_question(topic="Physics")
assert isinstance(question, Question)
assert question.value == expected
def test_simple_type_input():
class Question(pydantic.BaseModel):
value: str
class Answer(pydantic.BaseModel):
value: str
@predictor
def answer(question: Question) -> Answer:
pass
question = Question(value="What is the speed of light?")
lm = DummyLM([f'{{"value": "3e8"}}'])
dspy.settings.configure(lm=lm)
result = answer(question=question)
assert result == Answer(value="3e8")
def test_simple_class():
class Answer(pydantic.BaseModel):
value: float
certainty: float
comments: List[str] = pydantic.Field(description="At least two comments about the answer")
class QA(FunctionalModule):
@predictor
def hard_question(self, topic: str) -> str:
"""Think of a hard factual question about a topic. It should be answerable with a number."""
@cot
def answer(self, question: Annotated[str, "Question to answer"]) -> Answer:
pass
def forward(self, **kwargs):
question = self.hard_question(**kwargs)
return (question, self.answer(question=question))
expected = Answer(
value=3e8,
certainty=0.9,
comments=["It is the speed of light", "It is a constant"],
)
lm = DummyLM(
[
"What is the speed of light?",
"Some bad reasoning, 3e8 m/s.",
"3e8", # Bad answer 1
"{...}", # Model is asked to create an example
"Some good reasoning...",
expected.model_dump_json(), # Good answer
]
)
dspy.settings.configure(lm=lm)
qa = QA()
assert isinstance(qa, FunctionalModule)
assert isinstance(qa.answer, dspy.Module)
question, answer = qa(topic="Physics")
print(qa.answer)
assert question == "What is the speed of light?"
assert answer == expected
def test_simple_oop():
class Question(pydantic.BaseModel):
value: str
class MySignature(dspy.Signature):
topic: str = dspy.InputField()
output: Question = dspy.OutputField()
# Run the signature
program = TypedPredictor(MySignature)
expected = "What is the speed of light?"
lm = DummyLM(
[
Question(value=expected).model_dump_json(),
]
)
dspy.settings.configure(lm=lm)
question = program(topic="Physics").output
assert isinstance(question, Question)
assert question.value == expected
def test_equivalent_signatures():
class ClassSignature(dspy.Signature):
input: str = dspy.InputField()
output: str = dspy.OutputField()
@predictor
def output(input: str) -> str:
pass
function_signature = output.predictor.signature
simple_signature = dspy.Signature("input -> output")
assert ClassSignature.equals(function_signature)
assert ClassSignature.equals(simple_signature)
def test_named_params():
class QA(FunctionalModule):
@predictor
def hard_question(self, topic: str) -> str:
"""Think of a hard factual question about a topic. It should be answerable with a number."""
@cot
def answer(self, question: str) -> str:
pass
qa = QA()
named_predictors = list(qa.named_predictors())
assert len(named_predictors) == 2
names, _ = zip(*qa.named_predictors())
assert set(names) == {
"hard_question.predictor.predictor",
"answer.predictor.predictor",
}
def test_bootstrap_effectiveness():
class SimpleModule(FunctionalModule):
@predictor
def output(self, input: str) -> str:
pass
def forward(self, **kwargs):
return self.output(**kwargs)
def simple_metric(example, prediction, trace=None):
return example.output == prediction.output
examples = [
ex.with_inputs("input")
for ex in (
Example(input="What is the color of the sky?", output="blue"),
Example(
input="What does the fox say?",
output="Ring-ding-ding-ding-dingeringeding!",
),
)
]
trainset = [examples[0]]
valset = [examples[1]]
# This test verifies if the bootstrapping process improves the student's predictions
student = SimpleModule()
teacher = SimpleModule()
assert student.output.predictor.signature.equals(teacher.output.predictor.signature)
lm = DummyLM(["blue", "Ring-ding-ding-ding-dingeringeding!"], follow_examples=True)
dspy.settings.configure(lm=lm, trace=[])
bootstrap = BootstrapFewShot(metric=simple_metric, max_bootstrapped_demos=1, max_labeled_demos=1)
compiled_student = bootstrap.compile(student, teacher=teacher, trainset=trainset)
lm.inspect_history(n=2)
# Check that the compiled student has the correct demos
_, predict = next(compiled_student.named_sub_modules(Predict, skip_compiled=False))
demos = predict.demos
assert len(demos) == 1
assert demos[0].input == trainset[0].input
assert demos[0].output == trainset[0].output
# Test the compiled student's prediction.
# We are using a DummyLM with follow_examples=True, which means that
# even though it would normally reply with "Ring-ding-ding-ding-dingeringeding!"
# on the second output, if it seems an example that perfectly matches the
# prompt, it will use that instead. That is why we expect "blue" here.
prediction = compiled_student(input=trainset[0].input)
assert prediction == trainset[0].output
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `input`, produce the fields `output`.
---
Follow the following format.
Input: ${input}
Output: ${output}
---
Input: What is the color of the sky?
Output: blue
---
Input: What is the color of the sky?
Output: blue"""
)
def test_regex():
class TravelInformation(BaseModel):
origin: str = Field(pattern=r"^[A-Z]{3}$")
destination: str = Field(pattern=r"^[A-Z]{3}$")
date: datetime.date
@predictor
def flight_information(email: str) -> TravelInformation:
pass
email = textwrap.dedent(
"""\
We're excited to welcome you aboard your upcoming flight from
John F. Kennedy International Airport (JFK) to Los Angeles International Airport (LAX)
on December 25, 2022. Here's everything you need to know before you take off: ...
"""
)
lm = DummyLM(
[
# Example with a bad origin code.
'{"origin": "JF0", "destination": "LAX", "date": "2022-12-25"}',
# Example to help the model understand
"{...}",
# Fixed
'{"origin": "JFK", "destination": "LAX", "date": "2022-12-25"}',
]
)
dspy.settings.configure(lm=lm)
assert flight_information(email=email) == TravelInformation(
origin="JFK", destination="LAX", date=datetime.date(2022, 12, 25)
)
def test_custom_model_validate_json():
class Airport(BaseModel):
code: str = Field(pattern=r"^[A-Z]{3}$")
lat: float
lon: float
class TravelInformation(BaseModel):
origin: Airport
destination: Airport
date: datetime.date
@classmethod
def model_validate_json(
cls, json_data: str, *, strict: Optional[bool] = None, context: Optional[dict[str, Any]] = None
) -> "TravelInformation":
try:
__tracebackhide__ = True
return cls.__pydantic_validator__.validate_json(json_data, strict=strict, context=context)
except ValidationError:
for substring_length in range(len(json_data), 1, -1):
for start in range(len(json_data) - substring_length + 1):
substring = json_data[start : start + substring_length]
try:
__tracebackhide__ = True
res = cls.__pydantic_validator__.validate_json(substring, strict=strict, context=context)
return res
except ValidationError as exc:
last_exc = exc
pass
raise ValueError("Could not find valid json") from last_exc
@predictor
def flight_information(email: str) -> TravelInformation:
pass
email = textwrap.dedent(
"""\
We're excited to welcome you aboard your upcoming flight from
John F. Kennedy International Airport (JFK) to Los Angeles International Airport (LAX)
on December 25, 2022. Here's everything you need to know before you take off: ...
"""
)
lm = DummyLM(
[
# Example with a bad origin code.
(
"Here is your json: "
"{"
'"origin": {"code":"JFK", "lat":40.6446, "lon":-73.7797}, '
'"destination": {"code":"LAX", "lat":33.942791, "lon":-118.410042}, '
'"date": "2022-12-25"}'
),
]
)
dspy.settings.configure(lm=lm)
assert flight_information(email=email) == TravelInformation(
origin={"code": "JFK", "lat": 40.6446, "lon": -73.7797},
destination={"code": "LAX", "lat": 33.942791, "lon": -118.410042},
date=datetime.date(2022, 12, 25),
)
def test_raises():
class TravelInformation(BaseModel):
origin: str = Field(pattern=r"^[A-Z]{3}$")
destination: str = Field(pattern=r"^[A-Z]{3}$")
date: datetime.date
@predictor
def flight_information(email: str) -> TravelInformation:
pass
lm = DummyLM(
[
"A list of bad inputs",
'{"origin": "JF0", "destination": "LAX", "date": "2022-12-25"}',
'{"origin": "JFK", "destination": "LAX", "date": "bad date"}',
]
)
dspy.settings.configure(lm=lm)
with pytest.raises(ValueError):
flight_information(email="Some email")
def test_multi_errors():
class TravelInformation(BaseModel):
origin: str = Field(pattern=r"^[A-Z]{3}$")
destination: str = Field(pattern=r"^[A-Z]{3}$")
date: datetime.date
@predictor
def flight_information(email: str) -> TravelInformation:
pass
lm = DummyLM(
[
# First origin is wrong, then destination, then all is good
'{"origin": "JF0", "destination": "LAX", "date": "2022-12-25"}',
"{...}", # Example to help the model understand
'{"origin": "JFK", "destination": "LA0", "date": "2022-12-25"}',
"{...}", # Example to help the model understand
'{"origin": "JFK", "destination": "LAX", "date": "2022-12-25"}',
]
)
dspy.settings.configure(lm=lm)
assert flight_information(email="Some email") == TravelInformation(
origin="JFK", destination="LAX", date=datetime.date(2022, 12, 25)
)
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `email`, produce the fields `flight_information`.
---
Follow the following format.
Email: ${email}
Past Error in Flight Information: An error to avoid in the future
Past Error (2) in Flight Information: An error to avoid in the future
Flight Information: ${flight_information}. Respond with a single JSON object. JSON Schema: {"properties": {"origin": {"pattern": "^[A-Z]{3}$", "title": "Origin", "type": "string"}, "destination": {"pattern": "^[A-Z]{3}$", "title": "Destination", "type": "string"}, "date": {"format": "date", "title": "Date", "type": "string"}}, "required": ["origin", "destination", "date"], "title": "TravelInformation", "type": "object"}
---
Email: Some email
Past Error in Flight Information: String should match pattern '^[A-Z]{3}$': origin (error type: string_pattern_mismatch)
Past Error (2) in Flight Information: String should match pattern '^[A-Z]{3}$': destination (error type: string_pattern_mismatch)
Flight Information: {"origin": "JFK", "destination": "LAX", "date": "2022-12-25"}"""
)
def test_field_validator():
class UserDetails(BaseModel):
name: str
age: int
@field_validator("name")
@classmethod
def validate_name(cls, v):
if v.upper() != v:
raise ValueError("Name must be in uppercase.")
return v
@predictor
def get_user_details() -> UserDetails:
pass
# Keep making the mistake (lower case name) until we run
# out of retries.
lm = DummyLM(
[
'{"name": "lower case name", "age": 25}',
]
* 10
)
dspy.settings.configure(lm=lm)
with pytest.raises(ValueError):
get_user_details()
print(lm.get_convo(-1))
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields , produce the fields `get_user_details`.
---
Follow the following format.
Past Error in Get User Details: An error to avoid in the future
Past Error (2) in Get User Details: An error to avoid in the future
Get User Details: ${get_user_details}. Respond with a single JSON object. JSON Schema: {"properties": {"name": {"title": "Name", "type": "string"}, "age": {"title": "Age", "type": "integer"}}, "required": ["name", "age"], "title": "UserDetails", "type": "object"}
---
Past Error in Get User Details: Value error, Name must be in uppercase.: name (error type: value_error)
Past Error (2) in Get User Details: Value error, Name must be in uppercase.: name (error type: value_error)
Get User Details: {"name": "lower case name", "age": 25}"""
)
def test_annotated_field():
@predictor
def test(input: Annotated[str, Field(description="description")]) -> Annotated[float, Field(gt=0, lt=1)]:
pass
# First try 0, which fails, then try 0.5, which passes
lm = DummyLM(["0", "0.5"])
dspy.settings.configure(lm=lm)
output = test(input="input")
assert output == 0.5
def test_multiple_outputs():
lm = DummyLM([str(i) for i in range(100)])
dspy.settings.configure(lm=lm)
test = TypedPredictor("input -> output")
output = test(input="input", config=dict(n=3)).completions.output
assert output == ["0", "1", "2"]
def test_multiple_outputs_int():
lm = DummyLM([str(i) for i in range(100)])
dspy.settings.configure(lm=lm)
class TestSignature(dspy.Signature):
input: int = dspy.InputField()
output: int = dspy.OutputField()
test = TypedPredictor(TestSignature)
output = test(input=8, config=dict(n=3)).completions.output
assert output == [0, 1, 2]
def test_multiple_outputs_int_cot():
# Note: Multiple outputs only work when the language model "speculatively" generates all the outputs in one go.
lm = DummyLM(
[
"thoughts 0\nOutput: 0\n",
"thoughts 1\nOutput: 1\n",
"thoughts 2\nOutput: 2\n",
]
)
dspy.settings.configure(lm=lm)
test = TypedChainOfThought("input:str -> output:int")
output = test(input="8", config=dict(n=3)).completions.output
assert output == [0, 1, 2]
def test_parse_type_string():
lm = DummyLM([str(i) for i in range(100)])
dspy.settings.configure(lm=lm)
test = TypedPredictor("input:int -> output:int")
output = test(input=8, config=dict(n=3)).completions.output
assert output == [0, 1, 2]
def test_literal():
lm = DummyLM(['"2"', '"3"'])
dspy.settings.configure(lm=lm)
@predictor
def f() -> Literal["2", "3"]:
pass
assert f() == "2"
def test_literal_missmatch():
lm = DummyLM([f'"{i}"' for i in range(5, 100)])
dspy.settings.configure(lm=lm)
@predictor(max_retries=1)
def f() -> Literal["2", "3"]:
pass
with pytest.raises(Exception) as e_info:
f()
assert e_info.value.args[1]["f"] == "Input should be '2' or '3': (error type: literal_error)"
def test_literal_int():
lm = DummyLM(["2", "3"])
dspy.settings.configure(lm=lm)
@predictor
def f() -> Literal[2, 3]:
pass
assert f() == 2
def test_literal_int_missmatch():
lm = DummyLM([f"{i}" for i in range(5, 100)])
dspy.settings.configure(lm=lm)
@predictor(max_retries=1)
def f() -> Literal[2, 3]:
pass
with pytest.raises(Exception) as e_info:
f()
assert e_info.value.args[1]["f"] == "Input should be 2 or 3: (error type: literal_error)"
def test_fields_on_base_signature():
class SimpleOutput(dspy.Signature):
output: float = dspy.OutputField(gt=0, lt=1)
lm = DummyLM(
[
"2.1", # Bad output
"0.5", # Good output
]
)
dspy.settings.configure(lm=lm)
predictor = TypedPredictor(SimpleOutput)
assert predictor().output == 0.5
def test_synthetic_data_gen():
class SyntheticFact(BaseModel):
fact: str = Field(..., description="a statement")
varacity: bool = Field(..., description="is the statement true or false")
class ExampleSignature(dspy.Signature):
"""Generate an example of a synthetic fact."""
fact: SyntheticFact = dspy.OutputField()
lm = DummyLM(
[
'{"fact": "The sky is blue", "varacity": true}',
'{"fact": "The sky is green", "varacity": false}',
'{"fact": "The sky is red", "varacity": true}',
'{"fact": "The earth is flat", "varacity": false}',
'{"fact": "The earth is round", "varacity": true}',
'{"fact": "The earth is a cube", "varacity": false}',
]
)
dspy.settings.configure(lm=lm)
generator = TypedPredictor(ExampleSignature)
examples = generator(config=dict(n=3))
for ex in examples.completions.fact:
assert isinstance(ex, SyntheticFact)
assert examples.completions.fact[0] == SyntheticFact(fact="The sky is blue", varacity=True)
# If you have examples and want more
existing_examples = [
dspy.Example(fact="The sky is blue", varacity=True),
dspy.Example(fact="The sky is green", varacity=False),
]
trained = LabeledFewShot().compile(student=generator, trainset=existing_examples)
augmented_examples = trained(config=dict(n=3))
for ex in augmented_examples.completions.fact:
assert isinstance(ex, SyntheticFact)
def test_list_input2():
# Inspired by the Signature Optimizer
class ScoredString(pydantic.BaseModel):
string: str
score: float
class ScoredSignature(dspy.Signature):
attempted_signatures: list[ScoredString] = dspy.InputField()
proposed_signature: str = dspy.OutputField()
program = TypedChainOfThought(ScoredSignature)
lm = DummyLM(["Thoughts", "Output"])
dspy.settings.configure(lm=lm)
output = program(
attempted_signatures=[
ScoredString(string="string 1", score=0.5),
ScoredString(string="string 2", score=0.4),
ScoredString(string="string 3", score=0.3),
]
).proposed_signature
print(lm.get_convo(-1))
assert output == "Output"
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `attempted_signatures`, produce the fields `proposed_signature`.
---
Follow the following format.
Attempted Signatures: ${attempted_signatures}
Reasoning: Let's think step by step in order to ${produce the proposed_signature}. We ...
Proposed Signature: ${proposed_signature}
---
Attempted Signatures: [{"string":"string 1","score":0.5},{"string":"string 2","score":0.4},{"string":"string 3","score":0.3}]
Reasoning: Let's think step by step in order to Thoughts
Proposed Signature: Output"""
)
def test_custom_reasoning_field():
class Question(pydantic.BaseModel):
value: str
class QuestionSignature(dspy.Signature):
topic: str = dspy.InputField()
question: Question = dspy.OutputField()
reasoning = dspy.OutputField(
prefix="Custom Reasoning: Let's break this down. To generate a question about",
desc="${topic}, we should ...",
)
program = TypedChainOfThought(QuestionSignature, reasoning=reasoning)
expected = "What is the speed of light?"
lm = DummyLM(["Thoughts", f'{{"value": "{expected}"}}'])
dspy.settings.configure(lm=lm)
output = program(topic="Physics")
assert isinstance(output.question, Question)
assert output.question.value == expected
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `topic`, produce the fields `question`.
---
Follow the following format.
Topic: ${topic}
Custom Reasoning: Let's break this down. To generate a question about ${topic}, we should ...
Question: ${question}. Respond with a single JSON object. JSON Schema: {"properties": {"value": {"title": "Value", "type": "string"}}, "required": ["value"], "title": "Question", "type": "object"}
---
Topic: Physics
Custom Reasoning: Let's break this down. To generate a question about Thoughts
Question: {"value": "What is the speed of light?"}"""
)
def test_generic_signature():
T = TypeVar("T")
class GenericSignature(dspy.Signature, Generic[T]):
"""My signature"""
output: T = dspy.OutputField()
predictor = TypedPredictor(GenericSignature[int])
assert predictor.signature.instructions == "My signature"
lm = DummyLM(["23"])
dspy.settings.configure(lm=lm)
assert predictor().output == 23
def test_field_validator_in_signature():
class ValidatedSignature(dspy.Signature):
a: str = dspy.OutputField()
@pydantic.field_validator("a")
@classmethod
def space_in_a(cls, a: str) -> str:
if not " " in a:
raise ValueError("a must contain a space")
return a
with pytest.raises(pydantic.ValidationError):
_ = ValidatedSignature(a="no-space")
_ = ValidatedSignature(a="with space")
def test_lm_as_validator():
@predictor
def is_square(n: int) -> bool:
"""Is n a square number?"""
def check_square(n):
assert is_square(n=n)
return n
@predictor
def next_square(n: int) -> Annotated[int, AfterValidator(check_square)]:
"""What is the next square number after n?"""
lm = DummyLM(["3", "False", "4", "True"])
dspy.settings.configure(lm=lm)
m = next_square(n=2)
lm.inspect_history(n=2)
assert m == 4
def test_annotated_validator():
def is_square(n: int) -> int:
root = n**0.5
if not root.is_integer():
raise ValueError(f"{n} is not a square")
return n
class MySignature(dspy.Signature):
"""What is the next square number after n?"""
n: int = dspy.InputField()
next_square: Annotated[int, AfterValidator(is_square)] = dspy.OutputField()
lm = DummyLM(["3", "4"])
dspy.settings.configure(lm=lm)
m = TypedPredictor(MySignature)(n=2).next_square
lm.inspect_history(n=2)
assert m == 4
def test_annotated_validator_functional():
def is_square(n: int) -> int:
if not (n**0.5).is_integer():
raise ValueError(f"{n} is not a square")
return n
@predictor
def next_square(n: int) -> Annotated[int, AfterValidator(is_square)]:
"""What is the next square number after n?"""
lm = DummyLM(["3", "4"])
dspy.settings.configure(lm=lm)
m = next_square(n=2)
lm.inspect_history(n=2)
assert m == 4
def test_demos():
demos = [
dspy.Example(input="What is the speed of light?", output="3e8"),
]
program = LabeledFewShot(k=len(demos)).compile(
student=dspy.TypedPredictor("input -> output"),
trainset=[ex.with_inputs("input") for ex in demos],
)
lm = DummyLM(["Paris"])
dspy.settings.configure(lm=lm)
assert program(input="What is the capital of France?").output == "Paris"
assert lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `input`, produce the fields `output`.
---
Follow the following format.
Input: ${input}
Output: ${output}
---
Input: What is the speed of light?
Output: 3e8
---
Input: What is the capital of France?
Output: Paris"""
)
def _test_demos_missing_input():
demos = [dspy.Example(input="What is the speed of light?", output="3e8")]
program = LabeledFewShot(k=len(demos)).compile(
student=dspy.TypedPredictor("input -> output, thoughts"),
trainset=[ex.with_inputs("input") for ex in demos],
)
dspy.settings.configure(lm=DummyLM(["My thoughts", "Paris"]))
assert program(input="What is the capital of France?").output == "Paris"
assert dspy.settings.lm.get_convo(-1) == textwrap.dedent(
"""\
Given the fields `input`, produce the fields `output`.
---
Follow the following format.
Input: ${input}
Thoughts: ${thoughts}
Output: ${output}
---
Input: What is the speed of light?
Output: 3e8
---
Input: What is the capital of France?
Thoughts: My thoughts
Output: Paris"""
)
def test_conlist():
dspy.settings.configure(lm=DummyLM(["[]", "[1]", "[1, 2]", "[1, 2, 3]"]))
@predictor
def make_numbers(input: str) -> Annotated[list[int], Field(min_items=2)]:
pass
assert make_numbers(input="What are the first two numbers?") == [1, 2]
def test_conlist2():
dspy.settings.configure(lm=DummyLM(["[]", "[1]", "[1, 2]", "[1, 2, 3]"]))
make_numbers = TypedPredictor("input:str -> output:Annotated[List[int], Field(min_items=2)]")
assert make_numbers(input="What are the first two numbers?").output == [1, 2]
def test_model_validator():
class MySignature(dspy.Signature):
input_data: str = dspy.InputField()
allowed_categories: list[str] = dspy.InputField()
category: str = dspy.OutputField()
@model_validator(mode="after")
def check_cateogry(self):
if self.category not in self.allowed_categories:
raise ValueError(f"category not in {self.allowed_categories}")
return self
lm = DummyLM(["horse", "dog"])
dspy.settings.configure(lm=lm)
predictor = TypedPredictor(MySignature)
pred = predictor(input_data="What is the best animal?", allowed_categories=["cat", "dog"])
assert pred.category == "dog"