# Raga Testing Platform
The `raga-testing-platform` package provides a Python client for interacting with the Raga Testing Platform. It allows you to easily create and manage test sessions, datasets, and perform various testing operations.
## Installation
You can install `raga-testing-platform` using pip:
`pip install raga-testing-platform`
## Usage
To use the package, import the necessary classes and modules:
```
from raga import Dataset, TestSession, Auth
import pandas as pd
from typing import Optional, List, Dict
```
### Creating a test DataFrame
```
test_df = pd.DataFrame({
'column1': [1, 2, 3],
'column2': ['a', 'b', 'c']
})
```
### Defining the Schema class
```
class Schema:
def __init__(
self,
prediction_id: Optional[str] = None,
timestamp_column_name: Optional[str] = None,
feature_column_names: Optional[List[str]] = None,
metadata_column_names: Optional[List[str]] = None,
label_column_names: Optional[Dict[str, str]] = None,
embedding_column_names: Optional[Dict[str, str]] = None,
):
self.prediction_id = prediction_id
self.timestamp_column_name = timestamp_column_name
self.feature_column_names = feature_column_names
self.metadata_column_names = metadata_column_names
self.label_column_names = label_column_names
self.embedding_column_names = embedding_column_names
```
### Creating an instance of the Schema class
```
schema = Schema()
```
### Creating an instance of the Auth class
It will create auth token for further usages.
```
auth = Auth()
```
This variable stores auth token. You can use it untill expire token.
```
auth.token
```
### Creating an instance of the TestSession class
In this instance `experiment` will create and return `experiment_id`
```
experiment_id = TestSession(token, 1, "my_experiment")
```
This variable stores `experiment_id`. You can use it in further experiment.
```
experiment_id.experiment_id
```
### Creating an instance of the Dataset class
```
test_ds = Dataset(token, experiment_id, test_df, schema, "DatasetName")
```
### Loading labels from a file
```
test_ds.load_labels_from_file(
"/path/to/labels.json",
"dataset_name",
"id_column_name",
"label_column_name",
"metadata_column_name",
"category_column_name",
"category_id_column_name"
)
```
### To Debug
```
export DEBUG=1
```
Raw data
{
"_id": null,
"home_page": null,
"name": "raga-testing-platform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Raga AI <support@ragaai.com>",
"keywords": "testing-platform, raga-testing-platform, model-testing, AB_testing",
"author": null,
"author_email": "Raga AI <support@ragaai.com>",
"download_url": "https://files.pythonhosted.org/packages/10/4b/a049128175f718fc24879aa9cb5996597cbfe5f96971c103235ff442d02a/raga_testing_platform-1.1.74.tar.gz",
"platform": null,
"description": "\n# Raga Testing Platform\n\nThe `raga-testing-platform` package provides a Python client for interacting with the Raga Testing Platform. It allows you to easily create and manage test sessions, datasets, and perform various testing operations.\n\n\n## Installation\nYou can install `raga-testing-platform` using pip:\n\n`pip install raga-testing-platform`\n\n## Usage\nTo use the package, import the necessary classes and modules:\n\n```\nfrom raga import Dataset, TestSession, Auth\nimport pandas as pd\nfrom typing import Optional, List, Dict\n```\n### Creating a test DataFrame\n\n```\ntest_df = pd.DataFrame({\n 'column1': [1, 2, 3],\n 'column2': ['a', 'b', 'c']\n})\n```\n### Defining the Schema class\n\n```\nclass Schema:\n def __init__(\n self,\n prediction_id: Optional[str] = None,\n timestamp_column_name: Optional[str] = None,\n feature_column_names: Optional[List[str]] = None,\n metadata_column_names: Optional[List[str]] = None,\n label_column_names: Optional[Dict[str, str]] = None,\n embedding_column_names: Optional[Dict[str, str]] = None,\n ):\n self.prediction_id = prediction_id\n self.timestamp_column_name = timestamp_column_name\n self.feature_column_names = feature_column_names\n self.metadata_column_names = metadata_column_names\n self.label_column_names = label_column_names\n self.embedding_column_names = embedding_column_names\n```\n\n### Creating an instance of the Schema class\n```\nschema = Schema()\n```\n\n### Creating an instance of the Auth class\nIt will create auth token for further usages.\n```\nauth = Auth()\n```\n\nThis variable stores auth token. You can use it untill expire token.\n```\nauth.token\n```\n\n### Creating an instance of the TestSession class\nIn this instance `experiment` will create and return `experiment_id`\n```\nexperiment_id = TestSession(token, 1, \"my_experiment\")\n```\nThis variable stores `experiment_id`. You can use it in further experiment.\n```\nexperiment_id.experiment_id\n```\n### Creating an instance of the Dataset class\n\n```\ntest_ds = Dataset(token, experiment_id, test_df, schema, \"DatasetName\")\n```\n\n### Loading labels from a file\n\n```\ntest_ds.load_labels_from_file(\n \"/path/to/labels.json\",\n \"dataset_name\",\n \"id_column_name\",\n \"label_column_name\",\n \"metadata_column_name\",\n \"category_column_name\",\n \"category_id_column_name\"\n)\n```\n\n### To Debug\n```\nexport DEBUG=1\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Short description or overview of the raga package.",
"version": "1.1.74",
"project_urls": {
"Bug Tracker": "https://github.com/whoosh-labs/testing-platform-python-client/issues",
"Homepage": "https://github.com/whoosh-labs/testing-platform-python-client"
},
"split_keywords": [
"testing-platform",
" raga-testing-platform",
" model-testing",
" ab_testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73370620f0ad9a320288d31af1cec75d9a901d14423538a66e81ef95c4d1ea01",
"md5": "5b6895dae34b57026d61c07c1ed8ffb2",
"sha256": "a33d111755ef7a91c6f71764389488541f1df314c1bb7034d6c9360d075e4e99"
},
"downloads": -1,
"filename": "raga_testing_platform-1.1.74-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b6895dae34b57026d61c07c1ed8ffb2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 190718,
"upload_time": "2024-11-13T15:57:20",
"upload_time_iso_8601": "2024-11-13T15:57:20.806397Z",
"url": "https://files.pythonhosted.org/packages/73/37/0620f0ad9a320288d31af1cec75d9a901d14423538a66e81ef95c4d1ea01/raga_testing_platform-1.1.74-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "104ba049128175f718fc24879aa9cb5996597cbfe5f96971c103235ff442d02a",
"md5": "272c94a5d6d456fbc209dae3bba1112e",
"sha256": "88b3a1dab8538d8931801c933203d7a5d96c6147c4ee7a905dae359ee5b3cebe"
},
"downloads": -1,
"filename": "raga_testing_platform-1.1.74.tar.gz",
"has_sig": false,
"md5_digest": "272c94a5d6d456fbc209dae3bba1112e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6042908,
"upload_time": "2024-11-13T15:57:25",
"upload_time_iso_8601": "2024-11-13T15:57:25.508167Z",
"url": "https://files.pythonhosted.org/packages/10/4b/a049128175f718fc24879aa9cb5996597cbfe5f96971c103235ff442d02a/raga_testing_platform-1.1.74.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 15:57:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whoosh-labs",
"github_project": "testing-platform-python-client",
"github_not_found": true,
"lcname": "raga-testing-platform"
}
JSON
