Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UPDATE] Clarification Needed on System Prompt Implementation in Unit 1 tutorial.mdx #212

Open
yuka-with-data opened this issue Feb 20, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@yuka-with-data
Copy link

  1. If you want to add a full section or a new unit, please describe precisely what you want to add before starting to write it so that we can review the idea, validate it or not, and guide you through the writing process.

Hi team,
I noticed a slight disconnect between "Dummy Agent Library" page and the tutorial on "Let's Create Our First Agent Using smolagents". The Dummy Agent Library page introduces the concept of system prompting, but the tutorial does not explicitly demonstrate how to integrate a system prompting into the agent.
From the tutorial's code, it looks like the system prompt is stored in a prompts.yaml, as shown in the Space, and loaded into CodeAgent using the prompt_templates argument. However, there is no explanation in the text or comments to clarify this implementation.
I believe adding a brief explanation in the tutorial's text and/or comments within the code block would help bridge the gap for learners.
For example:

  • A short note on how prompts.yaml is structured and its role in system prompting: Since system prompting is already explained in the previous page, it would be helpful to add a brief notes in the turorial mentioning that system prompt text is saved in a YAML file located in the agent's file directory. This would help learners understand where the prompt data is coming from when it's loaded into the agent.

  • A comment in the code block explaining how prompt_templates is passed to CodeAgent: Adding a comment in the tutorial's code block would clarify the purpose of prompt_templates.

Would it be possible to add these clarifications? I'd be happy to contribute by submitting a PR if that would be helpful.
Thanks for the great course.

@yuka-with-data yuka-with-data added the documentation Improvements or additions to documentation label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant