docs: add docstrings to Predict, ReAct, and BaseLM public methods#9486
Closed
GopalGB wants to merge 1 commit intostanfordnlp:mainfrom
Closed
docs: add docstrings to Predict, ReAct, and BaseLM public methods#9486GopalGB wants to merge 1 commit intostanfordnlp:mainfrom
GopalGB wants to merge 1 commit intostanfordnlp:mainfrom
Conversation
Add Google-style docstrings with code examples to public methods that were missing documentation: - Predict: reset, dump_state, forward, aforward, update_config, get_config - ReAct: forward, aforward - BaseLM: acall, inspect_history, update_history Resolves stanfordnlp#9485, ref stanfordnlp#8926
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
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.
Summary
Add Google-style docstrings with code examples to public methods across three core files. All follow the Google Python Style Guide and match the conventions established in #9444.
Files changed
dspy/predict/predict.pyreset,dump_state,forward,aforward,update_config,get_configdspy/predict/react.pyforward,aforwarddspy/clients/base_lm.pyacall,inspect_history,update_historyWhat each docstring includes
Argssection for every parameterReturnssection where applicable>>>doctest format where helpfulResolves #9485, ref #8926