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

Merge pull request #2 from huggingface/unit/onboarding_unit

Browse Source 
unit 0 for onboarding
This commit is contained in:
burtenshaw
2025-01-22 16:15:46 +01:00
committed by GitHub
parent e2939cdb25 2fd1b3359f
commit 3f1a5d9a26
11 changed files with 317 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
units/0_onboarding/01_welcome_to_the_course.mdx Normal file
View File

@@ -0,0 +1,134 @@
# Welcome to the 🤗 AI Agents Course [[introduction]]
<!-- TODO: Add thumbnail to dataset -->
<img src="https://huggingface.co/datasets/huggingface-ai-agents-course/course-images/resolve/main/en/unit0/thumbnail.jpg" alt="AI Agents Course thumbnail" width="100%"/>
Welcome to the most fascinating topic in Artificial Intelligence: **AI Agents**.
This course will **teach you about AI Agents from beginner to expert**. It's completely free and open-source!
In this on-boarding unit you'll:
- Learn more about the **course content**.
- **Define the path** you're going to take (either self-audit or certification process).
- Learn more **about us**.
- **Create your Hugging Face account** (it's free).
- **Sign-up to our Discord server**, the place where you can chat with your classmates and us (the Hugging Face team).
Let's get started!
## What to expect? [[expect]]
In this course, you will:
- 📖 Study AI Agents in **theory, design, and practice.**
- 🧑‍💻 Learn to **use established AI Agent libraries** such as [smolagents](https://huggingface.co/docs/smolagents/en/index), [LangChain](https://www.langchain.com/), and [LlamaIndex](https://www.llamaindex.ai/).
- 💾 Share your **AI agents on the Hub** and try powerful agents from the community.
- 🏆 Participate in challenges where you will **evaluate your agents against other students.**
- 🎓 **Earn a certificate of completion** by completing assignments.
And more!
At the end of this course you'll:
- 📖 Learn the basics of Agents from scratch.
- 🕵️ Build your own Agents using the latest libraries and tools.
Don't forget to **<a href="https://bit.ly/hf-learn-agents">sign up to the course</a>** (we are collecting your email to be able to **send you the links when each Unit is published and give you information about the challenges and updates).**
Sign up 👉 <a href="https://bit.ly/hf-learn-agents">here</a>
## 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** witha 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 -->
## 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%"/>
## 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%"/>
## 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%"/>
## 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.
## Who are we [[who-are-we]]
In this course, you have two types of challenges:
<!-- TODO: Add team BIOs -->
## What are the challenges in this course? [[challenges]]
In this new version of the course, you have two types of challenges:
- [A leaderboard](https://huggingface.co/spaces/huggingface-projects/AI-Agents-Leaderboard) to compare your agent's performance to others.
- [AI vs. AI challenges](https://huggingface.co/learn/ai-agents-course/unit7/introduction?fw=pt) where you can train your agent and compete against other classmates' agents.
<img src="https://huggingface.co/datasets/huggingface-ai-agents-course/course-images/resolve/main/en/unit0/challenges.jpg" alt="Challenges" width="100%"/>
## 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>
## I still have questions [[questions]]
Please ask your question in our <a href="https://discord.gg/ydHrjt3WP5">discord server #ai-agents-discussions.</a>

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%"/>

39
units/0_onboarding/05_tools.mdx Normal file
View File

@@ -0,0 +1,39 @@
# 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:
1. **Create your Hugging Face account** if it's not already done
2. **Sign up to Discord and introduce yourself** (don't be shy 🤗)
### Let's create my Hugging Face account
(If it's not already done) create an account to HF <a href="https://huggingface.co/join">here</a>
### Let's join our Discord server
You can now sign up for our Discord Server. This is the place where you **can chat with the community and with us, create and join study groups to grow with each other and more**
👉🏻 Join our discord server <a href="https://discord.gg/UrrTSsSyjb">here.</a>
When you join, remember to introduce yourself in #introduce-yourself and sign-up for AI Agents channels in #channels-and-roles.
We have multiple AI Agents-related channels:
- `agents-course`: where we give the latest information about the course.
- `smolagents`: where you can discuss and get support with the library.
If this is your first time using Discord, we wrote a Discord 101 to get the best practices. Check the next section.
Congratulations! **You've just finished the on-boarding**. You're now ready to start to learn about AI Agents. Have fun!
### Keep Learning, stay awesome 🤗

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>

30
units/0_onboarding/10_discord_101.mdx Normal file
View File

@@ -0,0 +1,30 @@
# Discord 101 [[discord-101]]
Welcome to the AI Agents Course! This guide is designed to help you get started with Discord, a free chat platform similar to Slack.
<img src="https://huggingface.co/datasets/huggingface-ai-agents-course/course-images/resolve/main/en/unit0/huggy-logo.jpg" alt="Huggy Logo"/>
Join the Hugging Face Community Discord server, which has over 50,000 members, by clicking [here](https://discord.gg/ydHrjt3WP5). It's a great place to connect with others!
Starting on Discord can be a bit overwhelming, so here's a quick guide to help you navigate.
When you [sign up for our Discord server](http://hf.co/join/discord), you'll be prompted to choose your interests. Be sure to select **"AI Agents"** to gain access to the AI Agents Category, which includes all the course-related channels. Feel free to explore and join additional channels if you wish! 🚀
After signing up, introduce yourself in the `#introduce-yourself` channel.
<img src="https://huggingface.co/datasets/huggingface-ai-agents-course/course-images/resolve/main/en/unit0/discord2.jpg" alt="Discord"/>
In the AI Agents category, make sure to sign up for these channels by clicking on 🤖 AI Agents in `role-assignment`:
- `agents-course`: for the **latest course information**.
- `smolagents`: for **discussion and support with the library**.
The HF Community Server hosts a vibrant community with interests in various areas, offering opportunities for learning through paper discussions, events, and more.
Here are a few tips for using Discord effectively:
- **Voice channels** are available, though text chat is more commonly used.
- You can format text using **markdown style**, which is especially useful for writing code. Note that markdown doesn't work as well for links.
- Consider opening threads for **long conversations** to keep discussions organized.
We hope you find this guide helpful! If you have any questions, feel free to ask.

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