Skip to content

Allow arbitrary writeup in the api reference #8123

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
Apr 27, 2025
Merged

Allow arbitrary writeup in the api reference #8123

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
ef4f143
allow arbitrary writeup in the api reference
chenmoneygithub Apr 26, 2025
b85d5b8
update summary
chenmoneygithub Apr 26, 2025
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
3 changes: 3 additions & 0 deletions docs/docs/api/adapters/Adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.Adapter

<!-- START_API_REF -->
::: dspy.Adapter
handler: python
options:
members:
- __call__
- acall
- format
- format_assistant_message_content
- format_conversation_history
Expand All @@ -22,3 +24,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/adapters/ChatAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.ChatAdapter

<!-- START_API_REF -->
::: dspy.ChatAdapter
handler: python
options:
members:
- __call__
- acall
- format
- format_assistant_message_content
- format_conversation_history
Expand All @@ -25,3 +27,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/adapters/JSONAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.JSONAdapter

<!-- START_API_REF -->
::: dspy.JSONAdapter
handler: python
options:
members:
- __call__
- acall
- format
- format_assistant_message_content
- format_conversation_history
Expand All @@ -25,3 +27,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/adapters/TwoStepAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.TwoStepAdapter

<!-- START_API_REF -->
::: dspy.TwoStepAdapter
handler: python
options:
members:
- __call__
- acall
- format
- format_assistant_message_content
- format_conversation_history
Expand All @@ -22,3 +24,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/evaluation/CompleteAndGrounded.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.evaluate.CompleteAndGrounded

<!-- START_API_REF -->
::: dspy.evaluate.CompleteAndGrounded
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/evaluation/Evaluate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.Evaluate

<!-- START_API_REF -->
::: dspy.Evaluate
handler: python
options:
Expand All @@ -13,3 +14,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/evaluation/SemanticF1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.evaluate.SemanticF1

<!-- START_API_REF -->
::: dspy.evaluate.SemanticF1
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/evaluation/answer_exact_match.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.evaluate.answer_exact_match

<!-- START_API_REF -->
::: dspy.evaluate.answer_exact_match
handler: python
options:
Expand All @@ -11,3 +12,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/evaluation/answer_passage_match.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.evaluate.answer_passage_match

<!-- START_API_REF -->
::: dspy.evaluate.answer_passage_match
handler: python
options:
Expand All @@ -11,3 +12,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/models/Embedder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.Embedder

<!-- START_API_REF -->
::: dspy.Embedder
handler: python
options:
members:
- __call__
- acall
show_source: true
show_root_heading: true
heading_level: 2
Expand All @@ -13,3 +15,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
4 changes: 4 additions & 0 deletions docs/docs/api/models/LM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# dspy.LM

<!-- START_API_REF -->
::: dspy.LM
handler: python
options:
members:
- __call__
- acall
- aforward
- copy
- dump_state
- finetune
Expand All @@ -22,3 +25,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/BestOfN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.BestOfN

<!-- START_API_REF -->
::: dspy.BestOfN
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
4 changes: 4 additions & 0 deletions docs/docs/api/modules/ChainOfThought.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# dspy.ChainOfThought

<!-- START_API_REF -->
::: dspy.ChainOfThought
handler: python
options:
members:
- __call__
- acall
- aforward
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +32,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/ChainOfThoughtWithHint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.ChainOfThoughtWithHint

<!-- START_API_REF -->
::: dspy.ChainOfThoughtWithHint
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/Module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.Module

<!-- START_API_REF -->
::: dspy.Module
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -28,3 +30,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/MultiChainComparison.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.MultiChainComparison

<!-- START_API_REF -->
::: dspy.MultiChainComparison
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/modules/Parallel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.Parallel

<!-- START_API_REF -->
::: dspy.Parallel
handler: python
options:
Expand All @@ -14,3 +15,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
4 changes: 4 additions & 0 deletions docs/docs/api/modules/Predict.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# dspy.Predict

<!-- START_API_REF -->
::: dspy.Predict
handler: python
options:
members:
- __call__
- acall
- aforward
- batch
- deepcopy
- dump_state
Expand Down Expand Up @@ -32,3 +35,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/Program.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.Program

<!-- START_API_REF -->
::: dspy.Program
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -28,3 +30,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/ProgramOfThought.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.ProgramOfThought

<!-- START_API_REF -->
::: dspy.ProgramOfThought
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/ReAct.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.ReAct

<!-- START_API_REF -->
::: dspy.ReAct
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -30,3 +32,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
3 changes: 3 additions & 0 deletions docs/docs/api/modules/Refine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# dspy.Refine

<!-- START_API_REF -->
::: dspy.Refine
handler: python
options:
members:
- __call__
- acall
- batch
- deepcopy
- dump_state
Expand All @@ -29,3 +31,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/optimizers/BetterTogether.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.BetterTogether

<!-- START_API_REF -->
::: dspy.BetterTogether
handler: python
options:
Expand All @@ -14,3 +15,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
2 changes: 2 additions & 0 deletions docs/docs/api/optimizers/BootstrapFewShot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# dspy.BootstrapFewShot

<!-- START_API_REF -->
::: dspy.BootstrapFewShot
handler: python
options:
Expand All @@ -14,3 +15,4 @@
show_object_full_path: false
separate_signature: false
inherited_members: true
<!-- END_API_REF -->
Loading