diff --git a/docs/get_started/quickstart.mdx b/docs/get_started/installation.mdx similarity index 87% rename from docs/get_started/quickstart.mdx rename to docs/get_started/installation.mdx index b139289..71252e5 100644 --- a/docs/get_started/quickstart.mdx +++ b/docs/get_started/installation.mdx @@ -1,23 +1,22 @@ --- -title: Quickstart -description: Let's get started! +title: Installation --- ## Installation ### Basic ```bash -pip install fastrepl +pip install "fastrepl" ``` ### With RAGAS ```bash -pip install fastrepl[ragas] +pip install "fastrepl[ragas]" ``` ### With Langfuse ```bash -pip install fastrepl[langfuse] +pip install "fastrepl[langfuse]" ``` You can find all releases [here](https://pypi.org/project/fastrepl). diff --git a/docs/get_started/rag_evaluation.mdx b/docs/get_started/rag_evaluation.mdx index ab0cd7e..ea08d67 100644 --- a/docs/get_started/rag_evaluation.mdx +++ b/docs/get_started/rag_evaluation.mdx @@ -7,7 +7,7 @@ There are many ways to tune a RAG pipeline. To do that, we need to evaluate its performance. In `fastrepl`, we have **RAGAS** support for evaluating RAG pipelines. ```python -pip install fastrepl[ragas] # don't forget to add `[ragas]` +pip install "fastrepl[ragas]" # don't forget to add `[ragas]` ``` `RAGAS` has these **metrics**: diff --git a/docs/mint.json b/docs/mint.json index a21a5f4..1cb2555 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -45,7 +45,7 @@ "group": "Get Started", "pages": [ "get_started/introduction", - "get_started/quickstart", + "get_started/installation", "get_started/general_evaluation", "get_started/rag_evaluation", "get_started/agent_evaluation",