Improve Docs of Custom Tools and Agents #23255
Merged
Conversation
This file contains 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
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
patrickvonplaten
changed the title
sayakpaul
reviewed
May 10, 2023
Comment on lines
+223
to
+227
| @property | ||
| def toolbox(self) -> Dict[str, Tool]: | ||
| """Get all tool currently available to the agent""" | ||
| return self._toolbox | ||
|
|
There was a problem hiding this comment.
What is the benefit of this design?
There was a problem hiding this comment.
To avoid the user changing agent.toolbox. They can still change a key, but not replace (and accidentally eras) the whole variable.
sgugger
pushed a commit
that referenced
this pull request
May 10, 2023
* Improve docs * correct tip format * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Correct grammer & spelling * Improve code style * make style ruff * make style final
gojiteji
pushed a commit
to gojiteji/transformers
that referenced
this pull request
Jun 5, 2023
* Improve docs * correct tip format * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Correct grammer & spelling * Improve code style * make style ruff * make style final
novice03
pushed a commit
to novice03/transformers
that referenced
this pull request
Jun 23, 2023
* Improve docs * correct tip format * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Correct grammer & spelling * Improve code style * make style ruff * make style final
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
This PR improves the docs explaining how to customize prompts and corrects some grammar, spelling, code snippets of both
transformers_agent.mdxandcustom_tools.mdx. Alsoagent.toolboxis made a get method / property which should help both with documentation and forbid the user to overwrite the attribute completely.