fix docs

Signed-off-by: Bryan Qiu <[email protected]>
bbqiu · Oct 27, 2023 · 452ae24 · 452ae24
1 parent 7f68a7d
commit 452ae24
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/source/python_api/mlflow.metrics.rst b/docs/source/python_api/mlflow.metrics.rst
@@ -121,7 +121,7 @@ Parameters:
   each input query. ``retriever_k`` defaults to 3. You can change ``retriever_k`` by using the 
   :py:func:`mlflow.evaluate` API:
 
-    1. ``evaluator_config={"k": 5}``
+    1. ``evaluator_config={"retriever_k": 5}``
     2. .. code-block:: python
 
         extra_metrics = [

diff --git a/mlflow/models/evaluation/base.py b/mlflow/models/evaluation/base.py
@@ -1354,10 +1354,11 @@ def evaluate(
           metrics.
         - **col_mapping**: A dictionary mapping column names in the input dataset or output
           predictions to column names used when invoking the evaluation functions.
-        - **k**: A parameter used when ``model_type="retriever"`` as the number of top-ranked
-          retrieved documents to use when computing the built-in metric :mod:`precision_at_k(k)
-          <mlflow.metrics.precision_at_k>` and :mod:`recall_at_k(k) <mlflow.metrics.recall_at_k>`.
-          Default value is 3. For all other model types, this parameter will be ignored.
+        - **retriever_k**: A parameter used when ``model_type="retriever"`` as the number of
+          top-ranked retrieved documents to use when computing the built-in metric
+          :mod:`precision_at_k(k) <mlflow.metrics.precision_at_k>` and
+          :mod:`recall_at_k(k) <mlflow.metrics.recall_at_k>`. Default value is 3. For all other
+          model types, this parameter will be ignored.
 
      - Limitations of evaluation dataset:
         - For classification tasks, dataset labels are used to infer the total number of classes.