-
Notifications
You must be signed in to change notification settings - Fork 660
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
docs: getting started #589
Conversation
docs/getstarted/monitoring.md
Outdated
Additionally, you can use the RAG metrics with other Machine Learning Model (MLM) observability tools like | ||
- [Langsmith](../howtos/integrations/langsmith.ipynb) | ||
- [Phoenix (Arize)](https://github.com/Arize-ai/phoenix) | ||
- [Langfuse](../howtos/integrations/langfuse.ipynb) | ||
- [OpenLayer](https://openlayer.com/) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are there anymore we can add to this list - ideally we can point them to our integrations page
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, pointing to the integration page would be ideal
docs/getstarted/evaluation.md
Outdated
|
||
Welcome to the ragas quickstart. We're going to get you up and running with ragas as quickly as you can so that you can go back to improving your Retrieval Augmented Generation pipelines while this library makes sure your changes are improving your entire pipeline. | ||
Once your test set is ready (whether you've created your own or used the [synthetic test set generation module](get-started-testset-generation)), it's time to evaluate your RAG pipeline. Our aim is to help you set up with Ragas as quickly as possible so that you can focus on enhancing your Retrieval Augmented Generation pipelines while this library ensures your changes are improving the entire pipeline. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a mistake?
while this library ensures your changes are improving the entire pipeline.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nope, its correct i think
async def fix_doc_with_llm(doc: File, llm: BaseChatModel) -> File: | ||
prompt = """\ | ||
fix the following grammar and spelling mistakes in the following text. | ||
Please keep the markdown format intact when reformating it. | ||
Do not make any change to the parts of text that are for formating or additional metadata for the core text in markdown. | ||
The target audience for this is developers so keep the tone serious and to the point without any marketing terms. | ||
The output text should me in .md format. | ||
|
||
text: {text} | ||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added a script that helps review docs too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've noticed that gpt4 actually helps a lot in keeping the tone professional and consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but I don't think the prompt is proper - can be improved
No description provided.