AutoGen Tutorial

[ekzhu]

Why are these changes needed?

Create a tutorial that covers the basic concepts of AutoGen, and expand to detailed topics.

Tutorial structure:

Table of content (displayed on the sidebar)

1. Introduction to AutoGen (What is AutoGeN, why AutoGen, first chat): https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/introduction.ipynb
2. Termination: https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/termination.ipynb
3. Human-in-the-loop and termination: https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/human-in-the-loop.ipynb
4. Code Executors (solves math problems, plot stock chart, docker and containerization setup): https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/code-executors.ipynb
5. Multi-agent conversation patterns: https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/conversation-patterns.ipynb

• Sequential Chat
• Group Chat
• Nested Chat

6. What's Next: https://github.com/microsoft/autogen/blob/tutorial/website/docs/tutorial/what-is-next.ipynb .

Related issue number

#1597

Checks

• I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
• I've added tests (if relevant) corresponding to the changes introduced in this PR.
• I've made sure all auto checks have passed.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.09%. Comparing base (78a5a6b) to head (0d5e4f1).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1702   +/-   ##
=======================================
  Coverage   37.09%   37.09%           
=======================================
  Files          64       64           
  Lines        6834     6836    +2     
  Branches     1502     1502           
=======================================
+ Hits         2535     2536    +1     
- Misses       4082     4083    +1     
  Partials      217      217           

Flag	Coverage Δ
unittests	37.09% <ø> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rickyloynd-microsoft]

@ekzhu We currently have two notebooks on teachability. Are they sufficient for the tutorial?

https://github.com/microsoft/autogen/blob/main/notebook/agentchat_teachability.ipynb
https://github.com/microsoft/autogen/blob/main/notebook/agentchat_teachable_oai_assistants.ipynb

[sonichi]

Do we duplicate notebooks in notebooks/ and Tutorials/ ?

[jackgerrits]

The proposed structure is a bit different to what we have on the roadmap - do you want to update the issue to reflect? #1597

[ekzhu]

Do we duplicate notebooks in notebooks/ and Tutorials/ ?

Perhaps. I am not sure at this point. The goal is for the tutorial notebooks to be rendered as webpages. So it should be inside the “website” directory? Also, I think it won't be duplicate because the tutorial should have a coherent flow.

[ekzhu]

The proposed structure is a bit different to what we have on the roadmap - do you want to update the issue to reflect? #1597

Right. I was thinking about making the tutorial shorter but making the detailed topics more “flat”. I can update the issue page if you agree with the layout here.

[ekzhu]

@ekzhu We currently have two notebooks on teachability. Are they sufficient for the tutorial?

main/notebook/agentchat_teachability.ipynb main/notebook/agentchat_teachable_oai_assistants.ipynb

Thanks! I think I can take them and combine them into one notebook and add some context, so it blends into the tutorial as a whole. So the tutorial version of teachability notebook is going to be different from the notebooks version of the notebook.

[sonichi]

Do we duplicate notebooks in notebooks/ and Tutorials/ ?

Perhaps. I am not sure at this point. The goal is for the tutorial notebooks to be rendered as webpages. So it should be inside the “website” directory? Also, I think it won't be duplicate because the tutorial should have a coherent flow.

Rendering them as webpages doesn't require the original notebook to be under the website. The current notebooks are renderable as long as they follow the guide.

[jackgerrits]

I think the tutorials should be website pages first and foremost. Notebooks under notebook/ are just rendered on the website under a big list of notebooks. However, for the docs we are putting more effort into we want to make sure the left navbar makes sense and represents a logical progression of teaching. So I agree with these tutorials being added under website/

[sonichi]

Is there any info about register_reply and more customized conversations built using it? A pointer is sufficient. I just want to be clear that the supported conversation patterns are beyond the examples.