Merge pull request #21 from jjmachan/fix/api_token

jjmachan · web-flow · commit cf994a319b83 · 2025-04-17T14:00:57.000-07:00
some polish
diff --git a/README.md b/README.md
@@ -22,6 +22,23 @@ $ pip install ragas_experimental
 
 ## Getting Started
 
-First lets init a
+First do signup to [beta.app.ragas.io](https://beta.app.ragas.io/) and
+generate the App Token and put it in the as the env variable
+`RAGAS_APP_TOKEN`.
+
+``` python
+import os
+# ideally you load this from a .env file so as to not commit it to the repo
+os.environ["RAGAS_APP_TOKEN"] = "api-key"
+```
+
+Now lets init a
 [`Project`](https://explodinggradients.github.io/ragas_experimental/project/core.html#project)
-from notion.
+in the App
+
+``` python
+from ragas_experimental import Project
+
+project = Project.create("my-project")
+project
+```
diff --git a/nbs/backends/ragas_api_client.ipynb b/nbs/backends/ragas_api_client.ipynb
@@ -24,7 +24,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "RAGAS_APP_TOKEN = \"apt.47bd-c55e4a45b27c-02f8-8446-1441f09b-651a8\"\n",
+    "RAGAS_APP_TOKEN = \"api_key\"\n",
     "RAGAS_API_ENDPOINT = \"https://api.dev.app.ragas.io\""
    ]
   },
diff --git a/nbs/dataset.ipynb b/nbs/dataset.ipynb
@@ -246,7 +246,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "RAGAS_APP_TOKEN = \"apt.47bd-c55e4a45b27c-02f8-8446-1441f09b-651a8\"\n",
+    "RAGAS_APP_TOKEN = \"api_key\"\n",
     "RAGAS_API_BASE_URL = \"https://api.dev.app.ragas.io\"\n",
     "\n",
     "os.environ[\"RAGAS_APP_TOKEN\"] = RAGAS_APP_TOKEN\n",
@@ -279,7 +279,7 @@
     }
    ],
    "source": [
-    "p = Project(project_id=\"3d9b529b-c23f-4e87-8a26-dd1923749aa7\", ragas_app_client=ragas_api_client)\n",
+    "p = Project(project_id=\"3d9b529b-c23f-4e87-8a26-dd1923749aa7\", ragas_api_client=ragas_api_client)\n",
     "test_dataset = p.create_dataset(name=\"TestModel_with_long_text\", model=TestModel)\n",
     "test_dataset"
    ]
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -57,7 +57,37 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "First lets init a `Project` from notion."
+    "First do signup to [beta.app.ragas.io](https://beta.app.ragas.io/) and generate the App Token and put it in the as the env variable `RAGAS_APP_TOKEN`. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "# ideally you load this from a .env file so as to not commit it to the repo\n",
+    "os.environ[\"RAGAS_APP_TOKEN\"] = \"api-key\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now lets init a `Project` in the App"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ragas_experimental import Project\n",
+    "\n",
+    "project = Project.create(\"my-project\")\n",
+    "project"
    ]
   }
  ],
diff --git a/nbs/project/core.ipynb b/nbs/project/core.ipynb
@@ -71,13 +71,13 @@
     "    def __init__(\n",
     "        self,\n",
     "        project_id: str,\n",
-    "        ragas_app_client: t.Optional[RagasApiClient] = None,\n",
+    "        ragas_api_client: t.Optional[RagasApiClient] = None,\n",
     "    ):\n",
     "        self.project_id = project_id\n",
-    "        if ragas_app_client is None:\n",
+    "        if ragas_api_client is None:\n",
     "            self._ragas_api_client = RagasApiClientFactory.create()\n",
     "        else:\n",
-    "            self._ragas_api_client = ragas_app_client\n",
+    "            self._ragas_api_client = ragas_api_client\n",
     "\n",
     "        # create the project\n",
     "        try:\n",
@@ -94,12 +94,12 @@
     "        cls,\n",
     "        name: str,\n",
     "        description: str = \"\",\n",
-    "        ragas_app_client: t.Optional[RagasApiClient] = None,\n",
+    "        ragas_api_client: t.Optional[RagasApiClient] = None,\n",
     "    ):\n",
-    "        ragas_app_client = RagasApiClientFactory.create()\n",
-    "        sync_version = async_to_sync(ragas_app_client.create_project)\n",
+    "        ragas_api_client = RagasApiClientFactory.create()\n",
+    "        sync_version = async_to_sync(ragas_api_client.create_project)\n",
     "        new_project = sync_version(title=name, description=description)\n",
-    "        return cls(new_project[\"id\"], ragas_app_client)\n",
+    "        return cls(new_project[\"id\"], ragas_api_client)\n",
     "\n",
     "    def delete(self):\n",
     "        sync_version = async_to_sync(self._ragas_api_client.delete_project)\n",
@@ -116,7 +116,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "RAGAS_APP_TOKEN = \"apt.47bd-c55e4a45b27c-02f8-8446-1441f09b-651a8\"\n",
+    "RAGAS_APP_TOKEN = \"api-key\"\n",
     "RAGAS_API_BASE_URL = \"https://api.dev.app.ragas.io\"\n",
     "\n",
     "os.environ[\"RAGAS_APP_TOKEN\"] = RAGAS_APP_TOKEN\n",
@@ -153,22 +153,22 @@
    "source": [
     "# | export\n",
     "@patch(cls_method=True)\n",
-    "def get(cls: Project, name: str, ragas_app_client: t.Optional[RagasApiClient] = None) -> Project:\n",
+    "def get(cls: Project, name: str, ragas_api_client: t.Optional[RagasApiClient] = None) -> Project:\n",
     "    \"\"\"Get an existing project by name.\"\"\"\n",
     "    # Search for project with given name\n",
-    "    if ragas_app_client is None:\n",
-    "        ragas_app_client = RagasApiClientFactory.create()\n",
+    "    if ragas_api_client is None:\n",
+    "        ragas_api_client = RagasApiClientFactory.create()\n",
     "\n",
     "    # get the project by name\n",
-    "    sync_version = async_to_sync(ragas_app_client.get_project_by_name)\n",
+    "    sync_version = async_to_sync(ragas_api_client.get_project_by_name)\n",
     "    project_info = sync_version(\n",
     "        project_name=name\n",
     "    )\n",
     "\n",
     "    # Return Project instance\n",
     "    return Project(\n",
     "        project_id=project_info[\"id\"],\n",
-    "        ragas_app_client=ragas_app_client,\n",
+    "        ragas_api_client=ragas_api_client,\n",
     "    )"
    ]
   },
diff --git a/nbs/project/experiments.ipynb b/nbs/project/experiments.ipynb
@@ -144,7 +144,7 @@
     }
    ],
    "source": [
-    "RAGAS_APP_TOKEN = \"apt.4e81-99ed3e6efdfe-bb9c-88e3-f88438f5-5dfef\"\n",
+    "RAGAS_APP_TOKEN = \"api-key\"\n",
     "RAGAS_API_BASE_URL = \"https://api.dev.app.ragas.io\"\n",
     "\n",
     "os.environ[\"RAGAS_APP_TOKEN\"] = RAGAS_APP_TOKEN\n",
@@ -458,32 +458,6 @@
     "    return commit_hash"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[31mSignature:\u001b[39m\n",
-      "show_doc(\n",
-      "    sym,\n",
-      "    renderer=\u001b[38;5;28;01mNone\u001b[39;00m,\n",
-      "    name: \u001b[33m'str | None'\u001b[39m = \u001b[38;5;28;01mNone\u001b[39;00m,\n",
-      "    title_level: \u001b[33m'int'\u001b[39m = \u001b[32m3\u001b[39m,\n",
-      ")\n",
-      "\u001b[31mDocstring:\u001b[39m Show signature and docstring for `sym`\n",
-      "\u001b[31mFile:\u001b[39m      ~/workspace/eglabs/ragas_annotator/.venv/lib/python3.12/site-packages/nbdev/showdoc.py\n",
-      "\u001b[31mType:\u001b[39m      function"
-     ]
-    }
-   ],
-   "source": [
-    "show_doc?"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -642,7 +616,7 @@
     "# | export\n",
     "@patch\n",
     "def experiment(\n",
-    "    self: Project, experiment_model, name_prefix: str = \"\", save_to_git: bool = True, stage_all: bool = False\n",
+    "    self: Project, experiment_model, name_prefix: str = \"\", save_to_git: bool = True, stage_all: bool = True\n",
     "):\n",
     "    \"\"\"Decorator for creating experiment functions without Langfuse integration.\n",
     "\n",
diff --git a/ragas_experimental/project/core.py b/ragas_experimental/project/core.py
@@ -25,13 +25,13 @@ class Project:
     def __init__(
         self,
         project_id: str,
-        ragas_app_client: t.Optional[RagasApiClient] = None,
+        ragas_api_client: t.Optional[RagasApiClient] = None,
     ):
         self.project_id = project_id
-        if ragas_app_client is None:
+        if ragas_api_client is None:
             self._ragas_api_client = RagasApiClientFactory.create()
         else:
-            self._ragas_api_client = ragas_app_client
+            self._ragas_api_client = ragas_api_client
 
         # create the project
         try:
@@ -48,12 +48,12 @@ def create(
         cls,
         name: str,
         description: str = "",
-        ragas_app_client: t.Optional[RagasApiClient] = None,
+        ragas_api_client: t.Optional[RagasApiClient] = None,
     ):
-        ragas_app_client = RagasApiClientFactory.create()
-        sync_version = async_to_sync(ragas_app_client.create_project)
+        ragas_api_client = RagasApiClientFactory.create()
+        sync_version = async_to_sync(ragas_api_client.create_project)
         new_project = sync_version(title=name, description=description)
-        return cls(new_project["id"], ragas_app_client)
+        return cls(new_project["id"], ragas_api_client)
 
     def delete(self):
         sync_version = async_to_sync(self._ragas_api_client.delete_project)
@@ -66,21 +66,21 @@ def __repr__(self):
 # %% ../../nbs/project/core.ipynb 8
 @patch(cls_method=True)
 def get(
-    cls: Project, name: str, ragas_app_client: t.Optional[RagasApiClient] = None
+    cls: Project, name: str, ragas_api_client: t.Optional[RagasApiClient] = None
 ) -> Project:
     """Get an existing project by name."""
     # Search for project with given name
-    if ragas_app_client is None:
-        ragas_app_client = RagasApiClientFactory.create()
+    if ragas_api_client is None:
+        ragas_api_client = RagasApiClientFactory.create()
 
     # get the project by name
-    sync_version = async_to_sync(ragas_app_client.get_project_by_name)
+    sync_version = async_to_sync(ragas_api_client.get_project_by_name)
     project_info = sync_version(project_name=name)
 
     # Return Project instance
     return Project(
         project_id=project_info["id"],
-        ragas_app_client=ragas_app_client,
+        ragas_api_client=ragas_api_client,
     )
 
 # %% ../../nbs/project/core.ipynb 12
diff --git a/ragas_experimental/project/experiments.py b/ragas_experimental/project/experiments.py
@@ -202,7 +202,7 @@ def version_experiment(
 
     return commit_hash
 
-# %% ../../nbs/project/experiments.ipynb 22
+# %% ../../nbs/project/experiments.ipynb 21
 def cleanup_experiment_branches(
     prefix: str = "ragas/",
     repo_path: t.Union[str, Path, None] = None,
@@ -281,26 +281,26 @@ def cleanup_experiment_branches(
 
     return deleted_branches
 
-# %% ../../nbs/project/experiments.ipynb 25
+# %% ../../nbs/project/experiments.ipynb 24
 @t.runtime_checkable
 class ExperimentProtocol(t.Protocol):
     async def __call__(self, *args, **kwargs): ...
     async def run_async(self, name: str, dataset: Dataset): ...
 
-# %% ../../nbs/project/experiments.ipynb 26
+# %% ../../nbs/project/experiments.ipynb 25
 from .naming import MemorableNames
 
-# %% ../../nbs/project/experiments.ipynb 27
+# %% ../../nbs/project/experiments.ipynb 26
 memorable_names = MemorableNames()
 
-# %% ../../nbs/project/experiments.ipynb 28
+# %% ../../nbs/project/experiments.ipynb 27
 @patch
 def experiment(
     self: Project,
     experiment_model,
     name_prefix: str = "",
     save_to_git: bool = True,
-    stage_all: bool = False,
+    stage_all: bool = True,
 ):
     """Decorator for creating experiment functions without Langfuse integration.
 
@@ -400,11 +400,11 @@ async def run_async(
 
     return decorator
 
-# %% ../../nbs/project/experiments.ipynb 32
+# %% ../../nbs/project/experiments.ipynb 31
 # this one we have to clean up
 from langfuse.decorators import observe
 
-# %% ../../nbs/project/experiments.ipynb 33
+# %% ../../nbs/project/experiments.ipynb 32
 @patch
 def langfuse_experiment(self: Project, experiment_model, name_prefix: str = ""):
     """Decorator for creating experiment functions with Langfuse integration.
@@ -436,7 +436,7 @@ async def langfuse_wrapped_func(*args, **kwargs):
 
     return decorator
 
-# %% ../../nbs/project/experiments.ipynb 40
+# %% ../../nbs/project/experiments.ipynb 39
 from mlflow import trace
 
 
@@ -481,7 +481,7 @@ async def run_async_with_mlflow(dataset: Dataset, name: t.Optional[str] = None):
 
     return decorator
 
-# %% ../../nbs/project/experiments.ipynb 41
+# %% ../../nbs/project/experiments.ipynb 40
 import logging
 from ..utils import plot_experiments_as_subplots
 

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`"metadata": {},`
`25`	`25`	`"outputs": [],`
`26`	`26`	`"source": [`
`27`		`- "RAGAS_APP_TOKEN = \"apt.47bd-c55e4a45b27c-02f8-8446-1441f09b-651a8\"\n",`
	`27`	`+ "RAGAS_APP_TOKEN = \"api_key\"\n",`
`28`	`28`	`"RAGAS_API_ENDPOINT = \"https://api.dev.app.ragas.io\""`
`29`	`29`	`]`
`30`	`30`	`},`