diff --git a/argilla/src/argilla/client/feedback/dataset/mixins.py b/argilla/src/argilla/client/feedback/dataset/mixins.py index 6b011b456f..50a5a31e32 100644 --- a/argilla/src/argilla/client/feedback/dataset/mixins.py +++ b/argilla/src/argilla/client/feedback/dataset/mixins.py @@ -95,6 +95,7 @@ def compute_agreement_metrics( Args: metric_names: Metric name or list of metric names of the metrics, dependent on the question type. question_name: Question for which we want to compute the metrics. + field_name: Name of the fields related to the question we want to analyse the agreement. Note: Currently, TextQuestion is not supported. diff --git a/argilla/src/argilla/client/feedback/metrics/agreement_metrics.py b/argilla/src/argilla/client/feedback/metrics/agreement_metrics.py index c927735579..e4105a31d6 100644 --- a/argilla/src/argilla/client/feedback/metrics/agreement_metrics.py +++ b/argilla/src/argilla/client/feedback/metrics/agreement_metrics.py @@ -186,7 +186,7 @@ class AgreementMetric(MetricBase): Example: >>> import argilla as rg >>> from argilla.client.feedback.metrics import AgreementMetric - >>> metric = AgreementMetric(dataset=dataset, question_name=question, filter_by={"response_status": "submitted"}) + >>> metric = AgreementMetric(dataset=dataset, question_name=question, field_name=field, filter_by={"response_status": "submitted"}) >>> metrics_report = metric.compute("alpha") """