azure_ml_sdk.utils.mlflow_models
================================

.. py:module:: azure_ml_sdk.utils.mlflow_models


Classes
-------

.. autoapisummary::

   azure_ml_sdk.utils.mlflow_models.MLFlowModel


Module Contents
---------------

.. py:class:: MLFlowModel(client: mlflow.tracking.MlflowClient)

   Class for querying MLflow models.

   .. attribute:: client

      MLflow tracking client.

      :type: MLflowClient


   .. py:attribute:: client


   .. py:method:: list_models()

      List all registered models' names.

      :returns: A list of all registered models.



   .. py:method:: check_model(model_name)

      Check if a model exists.

      :param model_name: The model name.
      :type model_name: str

      :returns: A boolean object.



   .. py:method:: query_model(model_name, tags)

      Query all registered version of a model.

      :param model_name: The model name.
      :type model_name: str
      :param tags: The list of tags.
      :type tags: list

      :returns: A DataFrame of the registered model versions.



   .. py:method:: find_best_model(model_name, tag)

      Find the best registered model.

      :param model_name: The model name.
      :type model_name: str
      :param tag: A tag that can have numerical values.

      :returns: The version of the best model.



   .. py:method:: find_best_value(model_name, tag)

      Find the best value from the registered models.

      :param model_name: The model name.
      :type model_name: str
      :param tag: A tag that can have numerical values.

      :returns: The best value of the registered models.