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

Simplify README #4712

merged 43 commits into from
Jan 9, 2025

Conversation

gagb
Copy link
Collaborator

@gagb gagb commented Dec 15, 2024

Fixes #4599

README.md Outdated Show resolved Hide resolved
@gagb gagb marked this pull request as ready for review December 17, 2024 18:28
@gagb
Copy link
Collaborator Author

gagb commented Dec 17, 2024

@rysweet and @victordibia, could I get minimal examples for .net and studio that is consistent with the python minimal example. @victordibia for studio should that be python code or a screenshot or a short screen recording video? Its okay to change the python example as long as the example across the ecosystem is consistent.

@gagb gagb marked this pull request as draft December 17, 2024 18:58
@victordibia
Copy link
Collaborator

victordibia commented Dec 17, 2024

For studio .. it could be the content below.

Note: AGS is still in dev mode ie the new version does not have a major version on pypi ..its still v0. ..dev ... so pip install will not give the latest version.

Should we only add this when the latest version is out?


AutoGen Studio provides an interface to declaratively define, debug and test agents. Installation instructions can be found here. Run autogenstudio from the command line.

autogenstudio ui --appdir new
ags_update.mp4

@gagb
Copy link
Collaborator Author

gagb commented Dec 17, 2024

For studio .. it could be the content below.

Note: AGS is still in dev mode ie the new version does not have a major version on pypi ..its still v0. ..dev ... so pip install will not give the latest version.

Should we only add this when the latest version is out?

AutoGen Studio provides an interface to declaratively define, debug and test agents. Installation instructions can be found here. Run autogenstudio from the command line.

autogenstudio ui --appdir new

ags_update.mp4

Thank you! It would be good if the video example was consistent with the python minimal example? Okay to update the python example as well. But we need consistency.

@ekzhu
Copy link
Collaborator

ekzhu commented Jan 6, 2025

@gagb we would like to include this as part of v0.4 release. ETA?

@gagb
Copy link
Collaborator Author

gagb commented Jan 6, 2025

@gagb we would like to include this as part of v0.4 release. ETA?

Yes will do this by tomorrow.

@gagb gagb marked this pull request as ready for review January 8, 2025 22:42
Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.48%. Comparing base (02ad98b) to head (dcfc3c6).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4712      +/-   ##
==========================================
- Coverage   68.49%   68.48%   -0.01%     
==========================================
  Files         156      156              
  Lines       10061    10061              
==========================================
- Hits         6891     6890       -1     
- Misses       3170     3171       +1     
Flag Coverage Δ
unittests 68.48% <ø> (-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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
gagb and others added 9 commits January 8, 2025 15:39
Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
…tions of AutoGen features, and format content for better readability.
@jackgerrits jackgerrits merged commit 3d6d661 into main Jan 9, 2025
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simplify the root README
6 participants