update docstrings

argilla-io · Jul 18, 2024 · 0992a8d · 0992a8d
1 parent 7203867
commit 0992a8d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git 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
@@ -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")
 
     """