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

docs: clean get-started #1816

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/getstarted/evals.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,13 @@ Viewing the sample-level results in a CSV file, as shown above, is fine for quic

For this you may sign up and setup [app.ragas.io]() easily. If not, you may use any alternative tools available to you.

In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas API key](https://app.ragas.io/dashboard/settings/app-tokens).
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas APP token](https://app.ragas.io/dashboard/settings/app-tokens).

Once you have the API key, you can use the `upload()` method to export the results to the dashboard.

```python
import os
os.environ["RAGAS_API_KEY"] = "your_api_key"
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
```

Now you can view the results in the dashboard by following the link in the output of the `upload()` method.
Expand Down
2 changes: 1 addition & 1 deletion docs/getstarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ If you have any questions about Ragas, feel free to join and ask in the `#questi
Let's get started!

- [Evaluate your first AI app](./evals.md)
- [Run ragas metrics for evaluating RAG](rag_evaluation.md)
- [Run ragas metrics for evaluating RAG](rag_eval.md)
- [Generate test data for evaluating RAG](rag_testset_generation.md)
8 changes: 4 additions & 4 deletions docs/getstarted/rag_eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ from ragas.llms import LangchainLLMWrapper


evaluator_llm = LangchainLLMWrapper(llm)
from ragas.metrics import LLMContextRecall, LLMContextPrecisionWithReference, Faithfulness, FactualCorrectness
from ragas.metrics import LLMContextRecall, Faithfulness, FactualCorrectness

result = evaluate(dataset=evaluation_dataset,metrics=[LLMContextRecall(), Faithfulness(), FactualCorrectness()],llm=evaluator_llm)
result
Expand All @@ -180,19 +180,19 @@ Output

Once you have evaluated, you may want to view, analyse and share results. This is important to interpret the results and understand the performance of your RAG system. For this you may sign up and setup [app.ragas.io]() easily. If not, you may use any alternative tools available to you.

In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas API key](https://app.ragas.io/dashboard/settings/app-tokens).
In order to use the [app.ragas.io](http://app.ragas.io) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to generate a [Ragas APP token](https://app.ragas.io/dashboard/settings/app-tokens).

Once you have the API key, you can use the `upload()` method to export the results to the dashboard.

```python
import os
os.environ["RAGAS_API_KEY"] = "your_api_key"
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
```

Now you can view the results in the dashboard by following the link in the output of the `upload()` method.

```python
results.upload()
result.upload()
```

![](rag_eval.gif)
Expand Down
81 changes: 0 additions & 81 deletions docs/getstarted/rag_evaluation.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/getstarted/rag_testset_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ dataset.to_pandas()

You can also use other tools like [app.ragas.io](https://app.ragas.io/) or any other similar tools available for you in the [Integrations](../howtos/integrations/index.md) section.

In order to use the [app.ragas.io](https://app.ragas.io/) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to have a [Ragas API key](https://app.ragas.io/settings/api-keys).
In order to use the [app.ragas.io](https://app.ragas.io/) dashboard, you need to have an account on [app.ragas.io](https://app.ragas.io/). If you don't have one, you can sign up for one [here](https://app.ragas.io/login). You will also need to have a [Ragas APP token](https://app.ragas.io/settings/api-keys).

Once you have the API key, you can use the `upload()` method to export the results to the dashboard.

```python
import os
os.environ["RAGAS_API_KEY"] = "your_api_key"
os.environ["RAGAS_APP_TOKEN"] = "your_app_token"
dataset.upload()
```

Expand Down
Loading