alihan/agents-course
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

restructure based on review

Browse Source
This commit is contained in:
burtenshaw
2025-01-22 14:48:56 +01:00
parent 939ba7f066
commit 2fd1b3359f
12 changed files with 126 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
units/0_onboarding/introduction.mdx → units/0_onboarding/01_welcome_to_the_course.mdx
View File

30
units/0_onboarding/02_what_youre_going_to_do.mdx Normal file
View File

@@ -0,0 +1,30 @@
# Course Syllabus
Here is the general syllabus for the course. With each unit a more detailed list of topics will be released.
| Chapter | Topic | Description |
| :---- | :---- | :---- |
| 0 | Onboarding | Set you up with the tools and platforms that you will use. |
| 1 | Agent Fundamentals | Explain Tools, Thoughts, Actions, Observations, and their formats. Explain LLMs, messages, special tokens and chat-template. Show a simple use case in generic python functions. |
| 2 | Frameworks | Understand how the fundamentals are implemented in popular libraries : smolAgents, LangGraph, LLamaIndex |
| 3 | Use Cases | Let's build some real life use cases ( open to PRs 🤗 from experienced Agent builders ) |
| 4 | Final Assignment | Build an agent for a selected benchmark and prove your understanding of Agents on the student leaderboard 🚀 |
*Over the coming weeks further bonus units will be released.*
## What does the course look like? [[course-look-like]]
The course is composed of:
- *A fundamental part*: where you learn a **concept in theory**.
- *A hands-on*: where you'll learn **to use established AI Agent libraries** to train your agents in unique environments. These hands-on will be **Hugging Face spaces** with a pre-configured environment!
- *Use case assignments*: where you'll apply the concepts you've learned to solve a real-world problem.
- *The Challenge*: you'll get to put your agent to compete against other agents in a challenge. There will also be [a leaderboard](https://huggingface.co/spaces/huggingface-projects/AI-Agents-Leaderboard) for you to compare the agents' performance.
<!-- TODO: Create a space for the leaderboard -->
## What's the syllabus? [[syllabus]]
This is the course's syllabus:
<!-- TODO: Add syllabus -->

27
units/0_onboarding/03_certification_and_the_idea.mdx Normal file
View File

@@ -0,0 +1,27 @@
## Two paths: choose your own adventure [[two-paths]]
<img src="https://huggingface.co/datasets/huggingface-agents-course/course-images/resolve/main/en/unit0/two-paths.jpg" alt="Two paths" width="100%"/>
You can choose to follow this course either:
- *To get a certificate of completion*: you need to complete 1 of the use case assignments and 1 of the challenges.
- *To get a certificate of honors*: you need to complete 100% of the assignments and 1 of the challenges.
- *As a simple audit*: you can participate in all challenges and do assignments if you want.
There's **no deadlines, the course is self-paced**.
Both paths **are completely free**.
Whatever path you choose, we advise you **to follow the recommended pace to enjoy the course and challenges with your fellow classmates.**
<!-- TODO: Validate grading for assignments -->
You don't need to tell us which path you choose. **If you get more than 80% of the assignments done, you'll get a certificate.**
## The Certification Process [[certification-process]]
The certification process is **completely free**:
<!-- TODO: Validate grading for assignments -->
- *To get a certificate of completion*: you need to complete 80% of the assignments.
- *To get a certificate of honors*: you need to complete 100% of the assignments.
Again, there's **no deadline** since the course is self paced. But our advice **is to follow the recommended pace section**.
<img src="https://huggingface.co/datasets/huggingface-agents-course/course-images/resolve/main/en/unit0/certification.jpg" alt="Course certification" width="100%"/>

9
units/0_onboarding/04_how_to_get_most_of_the_course.mdx Normal file
View File

@@ -0,0 +1,9 @@
## How to get most of the course? [[advice]]
To get most of the course, we have some advice:
1. <a href="https://discord.gg/ydHrjt3WP5">Join study groups in Discord </a>: studying in groups is always easier. To do that, you need to join our discord server. If you're new to Discord, no worries! We have some tools that will help you learn about it.
2. **Do the quizzes and assignments**: the best way to learn is to do and test yourself.
3. **Define a schedule to stay in sync**: you can use our recommended pace schedule below or create yours.
<img src="https://huggingface.co/datasets/huggingface-agents-course/course-images/resolve/main/en/unit0/advice.jpg" alt="Course advice" width="100%"/>

13
units/0_onboarding/setup.mdx → units/0_onboarding/05_tools.mdx
View File

@@ -1,4 +1,15 @@
# Setup [[setup]]
# Tools
This section will cover the tools you will need for the course.
## What tools do I need? [[tools]]
You need only 3 things:
- *A computer* with an internet connection.
- A *Hugging Face Account*: to push and load models. If you don't have an account yet, you can create one **[here](https://hf.co/join)** (it's free).
<img src="https://huggingface.co/datasets/huggingface-agents-course/course-images/resolve/main/en/unit0/tools.jpg" alt="Course tools needed" width="100%"/>
After all this information, it's time to get started. We're going to do two things:

9
units/0_onboarding/06_pace_recommended.mdx Normal file
View File

@@ -0,0 +1,9 @@
# Pace Recommended
This section will discuss the recommended pace for the course and any deadlines you should be aware of.
## What is the recommended pace? [[recommended-pace]]
<!-- TODO: Add calendar for pace -->
Each chapter in this course is designed **to be completed in 1 week, with approximately 3-4 hours of work per week**. However, you can take as much time as necessary to complete the course. If you want to dive into a topic more in-depth, we'll provide additional resources to help you achieve that.

8
units/0_onboarding/07_authors.mdx Normal file
View File

@@ -0,0 +1,8 @@
# Authors
This section will provide information about the authors of the course.
## Who are we [[who-are-we]]
In this course, you have two types of challenges:
<!-- TODO: Add team BIOs -->

10
units/0_onboarding/08_how_to_contribute_to_the_course.mdx Normal file
View File

@@ -0,0 +1,10 @@
# How to Contribute to the Course
This section will explain how you can contribute to the course.
## I found a bug, or I want to improve the course [[contribute]]
<!-- TODO: Add contribution pages -->
Contributions are welcomed 🤗
- If you *found a bug 🐛 in a notebook*, please <a href="https://github.com/huggingface/agents-course/issues">open an issue</a> and **describe the problem**.
- If you *want to improve the course*, you can <a href="https://github.com/huggingface/agents-course/pulls">open a Pull Request.</a>

7
units/0_onboarding/09_i_have_questions.mdx Normal file
View File

@@ -0,0 +1,7 @@
# I Have Questions
This section will address common questions and how to get help.
## I still have questions [[questions]]
Please ask your question in our <a href="https://discord.gg/ydHrjt3WP5">discord server #ai-agents-discussions.</a>

0
units/0_onboarding/discord101.mdx → units/0_onboarding/10_discord_101.mdx
View File

14
units/0_onboarding/README.md
View File

@@ -0,0 +1,14 @@
# Table of Contents
1. [Welcome to the Course](01_welcome_to_the_course.mdx)
2. [What you're going to do](02_what_youre_going_to_do.mdx)
3. [Certification (and the idea)](03_certification_and_the_idea.mdx)
4. [How to get most of the course](04_how_to_get_most_of_the_course.mdx)
5. [Tools](05_tools.mdx)
6. [Pace recommended (saying that there's a deadline)](06_pace_recommended.mdx)
7. [Authors](07_authors.mdx)
8. [How to contribute to the course](08_how_to_contribute_to_the_course.mdx)
9. [I have questions](09_i_have_questions.mdx)
10. [Discord 101](10_discord_101.mdx)
# Welcome to the Course

13
units/0_onboarding/syllabus.mdx
View File

@@ -1,13 +0,0 @@
# Course Syllabus
Here is the general syllabus for the course. With each unit a more detailed list of topics will be released.
| Chapter | Topic | Description |
| :---- | :---- | :---- |
| 0 | Onboarding | Set you up with the tools and platforms that you will use. |
| 1 | Agent Fundamentals | Explain Tools, Thoughts, Actions, Observations, and their formats. Explain LLMs, messages, special tokens and chat-template. Show a simple use case in generic python functions. |
| 2 | Frameworks | Understand how the fundamentals are implemented in popular libraries : smolAgents, LangGraph, LLamaIndex |
| 3 | Use Cases | Let’s build some real life use cases ( open to PRs 🤗 from experienced Agent builders ) |
| 4 | Final Assignment | Build an agent for a selected benchmark and prove your understanding of Agents on the student leaderboard 🚀 |
*Over the coming weeks further bonus units will be released.*