update cheatsheet #8538
Merged
update cheatsheet #8538
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the DSPy cheatsheet to include recently added APIs and corrects a header capitalization.
- Renames the
dspy.ReACTsection todspy.ReAct - Adds examples for the new
dspy.CodeActanddspy.ParallelAPIs - Introduces a “Tools and Utilities” section with
dspy.Tool,dspy.streamify,dspy.asyncify, usage tracking, and cache configuration
Comments suppressed due to low confidence (3)
docs/docs/cheatsheet.md:440
- [nitpick] Section header
track_usageis inconsistent with other DSPy API headings. Consider renaming to### dspy.settings.configure(track_usage=True)or prefixing withdspy.for clarity.
### track_usage
docs/docs/cheatsheet.md:73
- [nitpick] It would help readers to include a one-sentence description of what
dspy.CodeActdoes before the code block to improve context and clarity.
### dspy.CodeAct
docs/docs/cheatsheet.md:436
- Add
import asyncioat the top of thedspy.asyncifyexample to avoid aNameErrorwhen callingasyncio.run.
asyncio.run(dspy_program(question="What is DSPy"))
Collaborator
chenmoneygithub
left a comment
chenmoneygithub
left a comment
There was a problem hiding this comment.
Code LGTM, but one question for @okhat: do we want to keep maintaining this cheat sheet for long term?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add the newly added APIs to the cheatsheet.