Skip to content

Commit 103d3d7

Browse files
chenmoneygithubchenmoneygithub
authored
Allow arbitrary writeup in the api reference (#8123)
* allow arbitrary writeup in the api reference * update summary
1 parent 37feb1d commit 103d3d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+194
-16
lines changed

‎docs/docs/api/adapters/Adapter.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.Adapter
22

3+
<!-- START_API_REF -->
34
::: dspy.Adapter
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- format
911
- format_assistant_message_content
1012
- format_conversation_history
@@ -22,3 +24,4 @@
2224
show_object_full_path: false
2325
separate_signature: false
2426
inherited_members: true
27+
<!-- END_API_REF -->

‎docs/docs/api/adapters/ChatAdapter.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.ChatAdapter
22

3+
<!-- START_API_REF -->
34
::: dspy.ChatAdapter
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- format
911
- format_assistant_message_content
1012
- format_conversation_history
@@ -25,3 +27,4 @@
2527
show_object_full_path: false
2628
separate_signature: false
2729
inherited_members: true
30+
<!-- END_API_REF -->

‎docs/docs/api/adapters/JSONAdapter.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.JSONAdapter
22

3+
<!-- START_API_REF -->
34
::: dspy.JSONAdapter
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- format
911
- format_assistant_message_content
1012
- format_conversation_history
@@ -25,3 +27,4 @@
2527
show_object_full_path: false
2628
separate_signature: false
2729
inherited_members: true
30+
<!-- END_API_REF -->

‎docs/docs/api/adapters/TwoStepAdapter.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.TwoStepAdapter
22

3+
<!-- START_API_REF -->
34
::: dspy.TwoStepAdapter
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- format
911
- format_assistant_message_content
1012
- format_conversation_history
@@ -22,3 +24,4 @@
2224
show_object_full_path: false
2325
separate_signature: false
2426
inherited_members: true
27+
<!-- END_API_REF -->

‎docs/docs/api/evaluation/CompleteAndGrounded.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.evaluate.CompleteAndGrounded
22

3+
<!-- START_API_REF -->
34
::: dspy.evaluate.CompleteAndGrounded
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- batch
911
- deepcopy
1012
- dump_state
@@ -29,3 +31,4 @@
2931
show_object_full_path: false
3032
separate_signature: false
3133
inherited_members: true
34+
<!-- END_API_REF -->

‎docs/docs/api/evaluation/Evaluate.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# dspy.Evaluate
22

3+
<!-- START_API_REF -->
34
::: dspy.Evaluate
45
handler: python
56
options:
@@ -13,3 +14,4 @@
1314
show_object_full_path: false
1415
separate_signature: false
1516
inherited_members: true
17+
<!-- END_API_REF -->

‎docs/docs/api/evaluation/SemanticF1.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.evaluate.SemanticF1
22

3+
<!-- START_API_REF -->
34
::: dspy.evaluate.SemanticF1
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
- batch
911
- deepcopy
1012
- dump_state
@@ -29,3 +31,4 @@
2931
show_object_full_path: false
3032
separate_signature: false
3133
inherited_members: true
34+
<!-- END_API_REF -->

‎docs/docs/api/evaluation/answer_exact_match.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# dspy.evaluate.answer_exact_match
22

3+
<!-- START_API_REF -->
34
::: dspy.evaluate.answer_exact_match
45
handler: python
56
options:
@@ -11,3 +12,4 @@
1112
show_object_full_path: false
1213
separate_signature: false
1314
inherited_members: true
15+
<!-- END_API_REF -->

‎docs/docs/api/evaluation/answer_passage_match.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# dspy.evaluate.answer_passage_match
22

3+
<!-- START_API_REF -->
34
::: dspy.evaluate.answer_passage_match
45
handler: python
56
options:
@@ -11,3 +12,4 @@
1112
show_object_full_path: false
1213
separate_signature: false
1314
inherited_members: true
15+
<!-- END_API_REF -->

‎docs/docs/api/models/Embedder.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# dspy.Embedder
22

3+
<!-- START_API_REF -->
34
::: dspy.Embedder
45
handler: python
56
options:
67
members:
78
- __call__
9+
- acall
810
show_source: true
911
show_root_heading: true
1012
heading_level: 2
@@ -13,3 +15,4 @@
1315
show_object_full_path: false
1416
separate_signature: false
1517
inherited_members: true
18+
<!-- END_API_REF -->

0 commit comments

Comments
 (0)