docs: getting started #589
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jjmachan
commented
Feb 16, 2024
docs/getstarted/monitoring.md
Outdated
Comment on lines
15
to
20
| 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.
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.
yes, pointing to the integration page would be ideal
|
added emojies is that too much? |
shahules786
requested changes
Feb 16, 2024
docs/getstarted/evaluation.md
Outdated
| # Evaluating Your Test Set | ||
|
|
||
| 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.
Is this a mistake?
while this library ensures your changes are improving the entire pipeline.
There was a problem hiding this comment.
nope, its correct i think
jjmachan
commented
Feb 17, 2024
Comment on lines
+28
to
+37
| 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.
added a script that helps review docs too
There was a problem hiding this comment.
I've noticed that gpt4 actually helps a lot in keeping the tone professional and consistent.
There was a problem hiding this comment.
but I don't think the prompt is proper - can be improved
shahules786
approved these changes
Feb 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.