azure_ml_sdk.services.asset.environment
=======================================

.. py:module:: azure_ml_sdk.services.asset.environment


Classes
-------

.. autoapisummary::

   azure_ml_sdk.services.asset.environment.EnvironmentManager


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

.. py:class:: EnvironmentManager(ml_client: azure.ai.ml.MLClient)

   Bases: :py:obj:`altametris.azure_ml_sdk.services.asset.base.BaseAssetManager`


   Class for handling environments in Azure Machine Learning workspace.


   .. py:method:: _from_docker_image(docker_image: str, environment_name: str, environment_description: Optional[str] = None, environment_version: Optional[str] = None) -> azure.ai.ml.entities.Environment
      :staticmethod:


      Create en environment from a Docker image.

      :param docker_image: The URI of a docker image hosted in a Docker Hub or Azure Container Registry.
      :type docker_image: str
      :param environment_name: The name of the environment.
      :type environment_name: str
      :param environment_description: The description of the environment.
      :type environment_description: str
      :param environment_version: The version of the environment. Defaults to None.
      :type environment_version: str

      :returns: An environment object.



   .. py:method:: _from_dockerfile(dockerfile_dir: str, environment_name: str, environment_description: Optional[str] = None, environment_version: Optional[str] = None) -> azure.ai.ml.entities.Environment
      :staticmethod:


      Create en environment from a Dockerfile.

      :param dockerfile_dir: The directory containing the Dockerfile.
      :type dockerfile_dir: str
      :param environment_name: The name of the environment.
      :type environment_name: str
      :param environment_description: The description of the environment.
      :type environment_description: str
      :param environment_version: The version of the environment. Defaults to None.
      :type environment_version: str

      :returns: An environment object.



   .. py:method:: _from_conda_file(docker_image: str, conda_file: str, environment_name: str, environment_description: Optional[str] = None, environment_version: Optional[str] = None) -> azure.ai.ml.entities.Environment
      :staticmethod:


      Create en environment from a conda specification file.

      :param docker_image: The URI of a docker image hosted in a Docker Hub or Azure Container Registry.
      :type docker_image: str
      :param conda_file: The path to the conda specification file (.yaml).
      :type conda_file: str
      :param environment_name: The name of the environment.
      :type environment_name: str
      :param environment_description: The description of the environment.
      :type environment_description: str
      :param environment_version: The version of the environment. Defaults to None.
      :type environment_version: str

      :returns: An environment object.



   .. py:method:: build_environment(method: str, environment_name: str, environment_description: Optional[str] = None, environment_version: Optional[str] = None, docker_image: Optional[str] = None, dockerfile_dir: Optional[str] = None, conda_file: Optional[str] = None) -> azure.ai.ml.entities.Environment

      Create and build an environment using a defined method.

      :param method: Must be one of 'docker_image', 'dockerfile', or 'conda_file'.
      :type method: str
      :param environment_name: The name of the environment.
      :type environment_name: str
      :param environment_description: The description of the environment.
      :type environment_description: str
      :param environment_version: The version of the environment.
      :type environment_version: str
      :param docker_image: The URI of the Docker image.
      :type docker_image: str
      :param dockerfile_dir: The directory of the Dockerfile.
      :type dockerfile_dir: str
      :param conda_file: The path to the conda specification file.
      :type conda_file: str

      :returns: An environment object.