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

Readme Overhaul #2279

Merged
merged 9 commits into from
Nov 20, 2024
Merged

Readme Overhaul #2279

merged 9 commits into from
Nov 20, 2024

Conversation

mmabrouk
Copy link
Member

@mmabrouk mmabrouk commented Nov 20, 2024

Cleaning up the readme

Copy link

vercel bot commented Nov 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
agenta ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 4:40pm
agenta-documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 4:40pm

@mmabrouk mmabrouk marked this pull request as ready for review November 20, 2024 16:18
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Nov 20, 2024
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Nov 20, 2024
@mmabrouk mmabrouk requested a review from jp-agenta November 20, 2024 16:18
Copy link
Collaborator

@aakrem aakrem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small comments

README.md Outdated Show resolved Hide resolved
### [Self-host agenta](https://docs.agenta.ai/self-host/host-locally)

### [Check the Cookbook](https://docs.agenta.ai/guides/cookbooks/evaluations_with_sdk)
Agenta provides end-to-end tools for the entire LLMOps workflow: building (**LLM playground**, **evaluation**), deploying (**prompt and configuration management**), and monitoring (**LLM observability and tracing**).
Copy link
Collaborator

@aakrem aakrem Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean by building (LLM playground?
also evaluation should be outside of the ()

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the three steps are building deploying and monitoring, eval is in the building predeployment step

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add experimentation

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@aakrem aakrem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 20, 2024
Copy link
Member

@bekossy bekossy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mmabrouk mmabrouk merged commit def967d into main Nov 20, 2024
6 checks passed
@mmabrouk mmabrouk deleted the readme-overhaul branch November 20, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants