From f1115190650becbc034fd581d7e1ad443d225341 Mon Sep 17 00:00:00 2001 From: Jithin James Date: Mon, 10 Jul 2023 13:05:41 +0530 Subject: [PATCH] docs: fix quickstart and readme (#55) --- README.md | 4 ++-- docs/quickstart.ipynb | 30 +++++++++++------------------- 2 files changed, 13 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9bf95b516..aafc4f4fe 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,9 @@ To read more about our metrics, checkout [docs](/docs/metrics.md). If you want to get more involved with Ragas, check out our [discord server](https://discord.gg/5djav8GGNZ). It's a fun community where we geek out about LLM, Retrieval, Production issues and more. ## 🔍 Open Analytics -We track very basic usage metrics to guide us to figure out what our users want, what is working and what's not. As a young startup, we have to be brutally honest about this which is why we are tracking these metrics. But as an Open Startup we open-source all the data we collect. You can read more about this [here](https://github.com/explodinggradients/ragas/issues/49). If you want to take a look at exactly what we track, feel free to check the [code](./src/ragas/_analytics.py) +We track very basic usage metrics to guide us to figure out what our users want, what is working and what's not. As a young startup, we have to be brutally honest about this which is why we are tracking these metrics. But as an Open Startup we open-source all the data we collect. You can read more about this [here](https://github.com/explodinggradients/ragas/issues/49). **Ragas doesnot track any information that can be used to identify you or your company**. You can take a look at exactly what we track in the [code](./src/ragas/_analytics.py) -You can disable usage-tracking if you want by setting the `RAGAS_DO_NOT_TRACK` flag to true. +To disable usage-tracking you set the `RAGAS_DO_NOT_TRACK` flag to true. ## :raising_hand_man: FAQ diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 205837316..390177dae 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -5,12 +5,15 @@ "id": "2e63f667", "metadata": {}, "source": [ - "\n", - " \"Open\n", - "\n", - "# Quickstart\n", + "

\n", + " \n", + " \"Open\n", + " \n", + "
\n", + "

Quickstart

\n", + "

\n", "\n", "welcome to the ragas quickstart. We're going to get you up and running with ragas as qickly 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.\n", "\n", @@ -20,7 +23,7 @@ { "cell_type": "code", "execution_count": 1, - "id": "18274e1f", + "id": "57585b55", "metadata": {}, "outputs": [], "source": [ @@ -28,23 +31,12 @@ "#!pip install ragas" ] }, - { - "cell_type": "code", - "execution_count": 1, - "id": "57585b55", - "metadata": {}, - "outputs": [], - "source": [ - "%load_ext autoreload\n", - "%autoreload 2" - ] - }, { "cell_type": "markdown", "id": "c77789bb", "metadata": {}, "source": [ - "Ragas also uses OpenAI for running a metric so make sure you have your openai key ready and available in your environment" + "Ragas also uses OpenAI for running some metrics so make sure you have your openai key ready and available in your environment" ] }, {