huggingface / huggingface/agents-course

[NOT CLEAR] Let’s Create Our First Agent Using smolagents

Open
#260 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
32.6k
Forks
2.3k
PR merge metrics
No merged PRs in 30d

Description

Tutorial Lacks Clear Local Setup Instructions and Clarity

Issue Description:

I followed the "Let’s Create Our First Agent Using smolagents" tutorial, but I encountered several issues that greatly hinder the experience:

Lack of Setup Instructions:
The tutorial does not provide clear and detailed instructions on how to set up the project locally.
There is no information about installing dependencies, environment setup, or any potential configuration needed to run the agent on a local machine.

Clarity Issues:
Some parts of the tutorial (especially around the integration and usage of the tools) are ambiguous.
It is not immediately clear how to add or modify tools effectively since the instructions seem to assume familiarity with the codebase.

Local Run Issues:
The tutorial seems to focus on deploying the agent on a Hugging Face Space via duplication, but it would be extremely helpful to have step-by-step guidance for local testing and execution.
A troubleshooting guide for common pitfalls when setting up the project locally would be a valuable addition to the documentation.

Suggestions for Improvement:

Include a dedicated section for local setup instructions with:
A list of required dependencies and installation steps.
Configuration guidelines (e.g., environment variables, API keys, etc.).
Step-by-step instructions to run the agent locally using a basic script or CLI command.

Enhance clarity by:
Providing code examples for adding new tools beyond the provided examples.
Clarifying the overall flow, especially for developers who are new to agent-based frameworks like smolagents.

I believe that taking these points into account will significantly improve the developer experience !

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.