Skip to content

Commit

Permalink
docs: fix quickstart and readme (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
jjmachan authored Jul 10, 2023
1 parent fc09372 commit f111519
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 21 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 11 additions & 19 deletions docs/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
"id": "2e63f667",
"metadata": {},
"source": [
"<a href=\"https://colab.research.google.com/github/explodinggradients/ragas/blob/main/docs/quickstart.ipynb\">\n",
" <img alt=\"Open In Colab\" \n",
" align=\"left\"\n",
" src=\"https://colab.research.google.com/assets/colab-badge.svg\">\n",
"</a>\n",
"# Quickstart\n",
"<p>\n",
" <a href=\"https://colab.research.google.com/github/explodinggradients/ragas/blob/main/docs/quickstart.ipynb\">\n",
" <img alt=\"Open In Colab\" \n",
" align=\"left\"\n",
" src=\"https://colab.research.google.com/assets/colab-badge.svg\">\n",
" </a>\n",
" <br>\n",
" <h1> Quickstart </h1>\n",
"</p>\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",
Expand All @@ -20,31 +23,20 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "18274e1f",
"id": "57585b55",
"metadata": {},
"outputs": [],
"source": [
"# if using colab uncomment this\n",
"#!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"
]
},
{
Expand Down

0 comments on commit f111519

Please sign in to comment.