Dict dataset

Dict-Based Dataset.

Authors

Surya Mahadi (made.r.s.mahadi@gdplabs.id)

References

NONE

DictDataset(dataset, dataset_name=None, attachments_config=None)

Bases: BaseDataset

Dict-Based Dataset.

This class is a subclass of the BaseDataset class. It is used to store a dataset in a dictionary format.

Attributes:

Name	Type	Description
dataset	list[dict]	The dataset to evaluate.

Initialize the DictDataset class.

Parameters:

Name	Type	Description	Default
dataset	list[MetricInput]	The dataset to use for the evaluation.	required
dataset_name	str | None	The name of the dataset.	None
attachments_config	AttachmentConfig | dict[str, Any] | None	Configuration for loading attachments. Defaults to None.	None

from_csv(path, dataset_name=None, attachments_config=None, **kwargs) classmethod

Load a dataset from a CSV file.

Parameters:

Name	Type	Description	Default
path	str	The path to the CSV file.	required
dataset_name	str | None	The name of the dataset. If None, defaults to filename. Defaults to None.	None
attachments_config	AttachmentConfig | dict[str, Any] | None	Configuration for loading attachments. Defaults to None.	None
**kwargs	Any	Additional arguments to pass to pandas read_csv.	{}

Returns:

Name	Type	Description
DictDataset	DictDataset	The loaded dataset.

from_jsonl(path, dataset_name=None, attachments_config=None, **kwargs) classmethod

Load a dataset from a JSONL file.

Parameters:

Name	Type	Description	Default
path	str	The path to the JSONL file.	required
dataset_name	str | None	The name of the dataset. If None, defaults to filename. Defaults to None.	None
attachments_config	AttachmentConfig | dict[str, Any] | None	Configuration for loading attachments. Defaults to None.	None
**kwargs	Any	Additional arguments to pass to the constructor (deprecated, use attachments_config instead).	{}

Returns:

Name	Type	Description
DictDataset	DictDataset	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.