Add LLM-friendly documentation #1545
Closed
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
- Add LLM.md: Comprehensive library overview with quick start guide - Add smolagents_api_docs.md: Detailed API reference documentation These files provide LLM-friendly documentation to help developers understand and use the smolagents library without extensive research. The documentation covers all user-facing functions, classes, and methods with practical examples and usage patterns. Signed-off-by: Askdev.AI bot <askdevai-bot@users.noreply.github.com>
|
Agreed heavily |
| from smolagents import CodeAgent, HfApiModel, PythonInterpreterTool | ||
|
|
||
| # Create model and agent | ||
| model = HfApiModel("meta-llama/Llama-3.1-70B-Instruct") |
There was a problem hiding this comment.
This is outdated: we use InferenceClient and more recent models
| ```python | ||
| from smolagents import MultiStepAgent | ||
|
|
||
| MultiStepAgent( |
There was a problem hiding this comment.
This will never work, please run the code
|
Closing this since the bot is not likely to follow up on my comments. |
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.
These files provide LLM-friendly documentation to help developers
understand and use the smolagents library without extensive research.
The documentation covers all user-facing functions, classes, and methods
with practical examples and usage patterns.
Signed-off-by: Askdev.AI bot askdevai-bot@users.noreply.github.com