Spreadsheet dataset
Spreadsheet Dataset Class.
This class is a wrapper around the Spreadsheet dataset class. The dataset is loaded from a Google Sheet and converted to a Hugging Face dataset.
References
NONE
SpreadsheetDataset(dataset, dataset_name=None, attachments_config=None)
Bases: BaseDataset
Spreadsheet dataset class for the evaluator.
Attributes:
| Name | Type | Description |
|---|---|---|
dataset |
list[MetricInput]
|
The dataset to use for the evaluation. |
Initialize the SpreadsheetDataset class.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset |
Dataset
|
The dataset to use for the evaluation. |
required |
dataset_name |
str | None
|
The name of the dataset. Defaults to None. |
None
|
attachments_config |
AttachmentConfig | dict[str, Any] | None
|
Configuration for loading attachments. Defaults to None. |
None
|
from_gsheets(sheet_id, worksheet_name, client_email, private_key, dataset_name=None, attachments_config=None)
async
staticmethod
Load the dataset from Google Sheets.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sheet_id |
str
|
The ID of the Google Sheet. |
required |
worksheet_name |
str
|
The name of the worksheet within the Google Sheet. |
required |
client_email |
str
|
The client email for Google Sheets API. |
required |
private_key |
str
|
Base64-encoded private key for Google Sheets API. |
required |
dataset_name |
str | None
|
The name of the dataset. If None, defaults to worksheet_name. Defaults to None. |
None
|
attachments_config |
AttachmentConfig | dict[str, Any] | None
|
Configuration for loading attachments. Defaults to None. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
SpreadsheetDataset |
SpreadsheetDataset
|
The loaded dataset. |
load()
Load the dataset.
Returns:
| Type | Description |
|---|---|
list[MetricInput]
|
list[MetricInput]: The loaded dataset. |
validate()
Validate the dataset.
Raises:
| Type | Description |
|---|---|
ValueError
|
If the dataset is not a list of MetricInput. |