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

Simplify README #4712

Merged
merged 43 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
c989dc0
Simplify README
gagb Dec 15, 2024
51014d2
Update README with improved badge links and section titles
gagb Dec 15, 2024
9bfbf19
Enhance README with additional AutoGen Studio links and badges
gagb Dec 15, 2024
bc383fd
Update README to change autogenstudio badge color to purple
gagb Dec 15, 2024
fd050a6
Update README with example of AI agents collaboratively writing a poem
gagb Dec 15, 2024
f98a417
Add Examples section to README with link to examples
gagb Dec 17, 2024
f87d1c8
Add asyncio import to Minimal Python Example in README
gagb Dec 17, 2024
acca61e
Update README with example of multi-agent system for plotting stock p…
gagb Jan 8, 2025
ae248ea
Add Quick Start section to README with installation instructions
gagb Jan 8, 2025
553dbec
Update README to reflect upcoming features with placeholders for inst…
gagb Jan 8, 2025
8c9b922
Update Tutorial link in README to include additional resource
gagb Jan 8, 2025
9a4b2eb
Update installation link in README to point to the correct user guide
gagb Jan 8, 2025
89d3179
Merge branch 'main' into gagb-readme
gagb Jan 8, 2025
9b24986
Merge branch 'gagb-readme' of github.com:microsoft/autogen into gagb-…
gagb Jan 8, 2025
26b733c
Add landing image to README and enhance visual appeal
gagb Jan 8, 2025
c0871a3
Update installation link in README for Autogen Studio user guide
gagb Jan 8, 2025
082d967
Update README.md
gagb Jan 8, 2025
f4abc84
Update README.md
gagb Jan 8, 2025
49930d6
Update Studio link in README to point to the correct GitHub directory
gagb Jan 8, 2025
f74c4b1
Update README.md
gagb Jan 8, 2025
2e83ba4
Add migration guide reference for upgrading from AutoGen v0.2 in README
gagb Jan 8, 2025
946b58e
Fix Studio link in README to point to the correct directory
gagb Jan 8, 2025
77993cf
Update README to include links for Core API, AgentChat API, and Exten…
gagb Jan 8, 2025
ce96bf6
Update README.md
gagb Jan 8, 2025
07b326b
Update README.md
gagb Jan 8, 2025
d832222
Fix AutoGen Studio link in README for accurate navigation
gagb Jan 8, 2025
bd41e3d
Replace PyPi badges with a Documentation badge in README
gagb Jan 8, 2025
1e5022b
Update README.md
gagb Jan 8, 2025
92f880f
Update README.md
gagb Jan 8, 2025
9155061
Update README.md
gagb Jan 8, 2025
110d798
Merge branch 'main' into gagb-readme
gagb Jan 8, 2025
4123eec
Improve README.md: clarify installation instructions, enhance descrip…
gagb Jan 8, 2025
7f6091c
Update README.md: add AutoGen Bench section for benchmarking agent pe…
gagb Jan 8, 2025
150e7e0
Update README.md: clarify AutoGen framework description and add devel…
gagb Jan 8, 2025
cae2e87
Update README.md: enhance AutoGen framework description and clarify c…
gagb Jan 8, 2025
0eb4b7e
Update README.md: clarify AgentChat API description and its relation …
gagb Jan 8, 2025
f99905c
Update README.md: refine descriptions of AutoGen framework and ecosys…
gagb Jan 9, 2025
5523883
Update README.md: rename "Quick Start" section to "Installation" and …
gagb Jan 9, 2025
fede5c0
Update readme
ekzhu Jan 9, 2025
eabaca7
Update example
ekzhu Jan 9, 2025
a68d770
Update quickstart
ekzhu Jan 9, 2025
f47cb72
Merge branch 'main' into gagb-readme
jackgerrits Jan 9, 2025
dcfc3c6
Merge branch 'main' into gagb-readme
jackgerrits Jan 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
## AutoGen FAQs

### What is AutoGen 0.4?

AutoGen v0.4 is a rewrite of AutoGen from the ground up to create a more robust,
scalable, easier to use, cross-language library for building AI Agents.
Some key features include asynchronous messaging, support for scalable distributed agents,
modular extensible design (bring your own agents, implement behaviors however you like),
cross-language support, improved observability, and full typing integration.
It is a breaking change.

### Why these changes?

We listened to our AutoGen users, learned from what was working, and adapted to fix what wasn't.
We brought together wide-ranging teams working on many different types of AI Agents
and collaborated to design an improved framework with a more flexible
programming model and better scalability.

### Is this project still maintained?

We want to reaffirm our commitment to supporting both the original version of AutoGen (0.2) and the redesign (0.4). AutoGen 0.4 is still work-in-progress, and we shared the code now to build with the community. There are no plans to deprecate the original AutoGen anytime soon, and both versions will be actively maintained.

### Who should use it 0.4?

This code is still experimental, so expect changes and bugs while we work towards a stable 0.4 release. We encourage early adopters to
try it out, give us feedback, and contribute.
For those looking for a stable version we recommend to continue using 0.2

### I'm using AutoGen 0.2, should I upgrade?

If you consider yourself an early adopter, you are comfortable making some
changes to your code, and are willing to try it out, then yes.

### How do I still use AutoGen 0.2?

AutoGen 0.2 can be installed with:

```sh
pip install autogen-agentchat~=0.2
```

### Will AutoGen Studio be supported in 0.4?

Yes, this is on the [roadmap](#roadmap).
Our current plan is to enable an implementation of AutoGen Studio
on the AgentChat high level API which implements a set of agent functionalities
(agents, teams, etc).

### How do I migrate?

For users familiar with AutoGen, the AgentChat library in 0.4 provides similar concepts.
We are working on a migration guide.

### Is 0.4 done?

We are still actively developing AutoGen 0.4. One exciting new feature is the emergence of new SDKs for .NET. The python SDKs are further ahead at this time but our goal is to achieve parity. We aim to add additional languages in future releases.

### What is happening next? When will this release be ready?

We are still working on improving the documentation, samples, and enhancing the code. We are hoping to release before the end of the year when things are ready.

### What is the history of this project?

The rearchitecture of the framework started with multiple Microsoft teams coming together
to address the gaps and learnings from AutoGen 0.2 - merging ideas from several predecessor projects.
The team worked on this internally for some time to ensure alignment before moving work back to the open in October 2024.

### What is the official channel for support?

Use GitHub [Issues](https://github.com/microsoft/autogen/issues) for bug reports and feature requests.
Use GitHub [Discussions](https://github.com/microsoft/autogen/discussions) for general questions and discussions.

### Do you use Discord for communications?

We are unable to use the old Discord for project discussions, many of the maintainers no longer have viewing or posting rights there. Therefore, we request that all discussions take place on <https://github.com/microsoft/autogen/discussions/> or the [new discord server](https://aka.ms/autogen-discord).

### What about forks?

<https://github.com/microsoft/autogen/> remains the only official repo for development and support of AutoGen.
We are aware that there are thousands of forks of AutoGen, including many for personal development and startups building with or on top of the library. We are not involved with any of these forks and are not aware of any plans related to them.

### What is the status of the license and open source?

Our project remains fully open-source and accessible to everyone. We understand that some forks use different licenses to align with different interests. We will continue to use the most permissive license (MIT) for the project.

### Can you clarify the current state of the packages?

Currently, we are unable to make releases to the `pyautogen` package via Pypi due to a change to package ownership that was done without our involvement. Additionally, we are moving to using multiple packages to align with the new design. Please see details [here](https://microsoft.github.io/autogen/dev/packages/index.html).

### Can I still be involved?

We are grateful to all the contributors to AutoGen 0.2 and we look forward to continuing to collaborate with everyone in the AutoGen community.
Loading
Loading