Skip to content

Commit

Permalink
unindent gen ai metrics (mlflow#10390)
Browse files Browse the repository at this point in the history
Signed-off-by: Bryan Qiu <[email protected]>
Signed-off-by: swathi <[email protected]>
  • Loading branch information
bbqiu authored and KonakanchiSwathi committed Nov 29, 2023
1 parent 178f99c commit 62c7348
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/source/python_api/mlflow.metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ Evaluation results are stored as :py:class:`MetricValue <mlflow.metrics.MetricVa

We provide the following builtin factory functions to create :py:class:`EvaluationMetric <mlflow.metrics.EvaluationMetric>` for evaluating models. These metrics are computed automatically depending on the ``model_type``. For more information on the ``model_type`` parameter, see :py:func:`mlflow.evaluate()` API.

Regressor Metrics
-----------------

.. autofunction:: mlflow.metrics.mae

.. autofunction:: mlflow.metrics.mape
Expand All @@ -68,16 +71,27 @@ We provide the following builtin factory functions to create :py:class:`Evaluati

.. autofunction:: mlflow.metrics.r2_score

Classifier Metrics
------------------

.. autofunction:: mlflow.metrics.precision_score

.. autofunction:: mlflow.metrics.recall_score

.. autofunction:: mlflow.metrics.f1_score

Text Metrics
------------

.. autofunction:: mlflow.metrics.ari_grade_level

.. autofunction:: mlflow.metrics.flesch_kincaid_grade_level

Question Answering Metrics
---------------------------

Includes all of the above **Text Metrics** as well as the following:

.. autofunction:: mlflow.metrics.exact_match

.. autofunction:: mlflow.metrics.rouge1
Expand All @@ -95,7 +109,7 @@ We provide the following builtin factory functions to create :py:class:`Evaluati
.. autofunction:: mlflow.metrics.latency

Retriever Metrics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------

The following metrics are built-in metrics for the ``'retriever'`` model type, meaning they will be
automatically calculated with a default ``retriever_k`` value of 3.
Expand Down

0 comments on commit 62c7348

Please sign in to comment.