Skip to content

Commit effa4ab

Browse files
authored
docs: Refactor Code for Syntax Highlighting and URL Updates (#1634)
1 parent 02e7a46 commit effa4ab

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

docs/extra/components/choose_evaluator_llm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
pip install langchain-aws
3232
```
3333

34-
then you have to set your AWS credentials and configurations
34+
Then you have to set your AWS credentials and configurations
3535

3636
```python
3737
config = {
@@ -43,7 +43,7 @@
4343
}
4444
```
4545

46-
define you LLMs and wrap them in `LangchainLLMWrapper` so that it can be used with ragas.
46+
Define your LLMs and wrap them in `LangchainLLMWrapper` so that it can be used with ragas.
4747

4848
```python
4949
from langchain_aws import ChatBedrockConverse

docs/howtos/integrations/_llamaindex.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ You will need an testset to evaluate your `QueryEngine` against. You can either
1111
Let's see how that works with Llamaindex
1212

1313
# load the documents
14+
```python
1415
from llama_index.core import SimpleDirectoryReader
1516

1617
documents = SimpleDirectoryReader("./nyc_wikipedia").load_data()
18+
```
1719

18-
Now lets init the `TestsetGenerator` object with the corresponding generator and critic llms
20+
Now lets init the `TestsetGenerator` object with the corresponding generator and critic llms
1921

2022

2123
```python
@@ -171,7 +173,7 @@ Now that we have a `QueryEngine` for the `VectorStoreIndex` we can use the llama
171173
In order to run an evaluation with Ragas and LlamaIndex you need 3 things
172174

173175
1. LlamaIndex `QueryEngine`: what we will be evaluating
174-
2. Metrics: Ragas defines a set of metrics that can measure different aspects of the `QueryEngine`. The available metrics and their meaning can be found [here](https://github.com/explodinggradients/ragas/blob/main/docs/metrics.md)
176+
2. Metrics: Ragas defines a set of metrics that can measure different aspects of the `QueryEngine`. The available metrics and their meaning can be found [here](https://docs.ragas.io/en/latest/concepts/metrics/available_metrics/)
175177
3. Questions: A list of questions that ragas will test the `QueryEngine` against.
176178

177179
first lets generate the questions. Ideally you should use that you see in production so that the distribution of question with which we evaluate matches the distribution of questions seen in production. This ensures that the scores reflect the performance seen in production but to start off we'll be using a few example question.

docs/howtos/integrations/llamaindex.ipynb

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,16 @@
2929
"id": "096e5af0",
3030
"metadata": {},
3131
"source": [
32-
"# load the documents\n",
32+
"# load the documents"
33+
]
34+
},
35+
{
36+
"cell_type": "code",
37+
"execution_count": null,
38+
"id": "396085d5",
39+
"metadata": {},
40+
"outputs": [],
41+
"source": [
3342
"from llama_index.core import SimpleDirectoryReader\n",
3443
"\n",
3544
"documents = SimpleDirectoryReader(\"./nyc_wikipedia\").load_data()"
@@ -298,7 +307,7 @@
298307
"In order to run an evaluation with Ragas and LlamaIndex you need 3 things\n",
299308
"\n",
300309
"1. LlamaIndex `QueryEngine`: what we will be evaluating\n",
301-
"2. Metrics: Ragas defines a set of metrics that can measure different aspects of the `QueryEngine`. The available metrics and their meaning can be found [here](https://github.com/explodinggradients/ragas/blob/main/docs/metrics.md)\n",
310+
"2. Metrics: Ragas defines a set of metrics that can measure different aspects of the `QueryEngine`. The available metrics and their meaning can be found [here](https://docs.ragas.io/en/latest/concepts/metrics/available_metrics/)\n",
302311
"3. Questions: A list of questions that ragas will test the `QueryEngine` against. "
303312
]
304313
},

0 commit comments

Comments
 (0)