Update optimizer import documentation to use modern pattern #8980
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
Changed the documentation to reflect the current best practice of importing optimizers directly from dspy (e.g., `from dspy import MIPROv2`) rather than the legacy `from dspy.teleprompt import *` pattern. While the teleprompt import path still works for backward compatibility, the modern approach is cleaner and aligns with how optimizers are referenced throughout the rest of the documentation. Changes: - Updated line 38 to show `dspy.<OptimizerName>` import pattern - Updated example code to use `from dspy import BootstrapFewShotWithRandomSearch` 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Updated the example code to use `import dspy` followed by `dspy.BootstrapFewShotWithRandomSearch(...)` instead of importing the class directly. This matches the pattern used throughout the rest of the documentation. Also simplified line 38 to only mention the `dspy.<OptimizerName>` pattern, which is the standard approach in all code examples. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
While reading the optimizer docs, noticed the examples still referenced
from dspy.teleprompt import *, which is confusing since teleprompt is deprecated. Updated to use the moderndspy.<OptimizerName>pattern that's used throughout the rest of the documentation.Changes
dspy.<OptimizerName>access patternimport dspy→dspy.BootstrapFewShotWithRandomSearch(...)