functional
==========

.. py:module:: functional


Functions
---------

.. autoapisummary::

   functional.parse_component
   functional.parse_pipeline
   functional.parse_job
   functional.parse_online_endpoint
   functional.parse_online_deployment


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

.. py:function:: parse_component(component: azure.ai.ml.entities.CommandComponent) -> altametris.azure_ml_sdk.configs.models.ComponentConfig

   Parse an Azure ML component object.

   :param component: AML object, definition of a component.
   :type component: CommandComponent

   :returns: The config of the component.
   :rtype: ComponentConfig


.. py:function:: parse_pipeline(pipeline: azure.ai.ml.entities.PipelineJob) -> altametris.azure_ml_sdk.configs.models.PipelineConfig

   Parse an Azure ML pipeline object.

   :param pipeline: AML object, definition of a pipeline.
   :type pipeline: PipelineComponent

   :returns: The config of the pipeline.
   :rtype: PipelineConfig


.. py:function:: parse_job(job: azure.ai.ml.entities.Command) -> altametris.azure_ml_sdk.configs.models.JobConfig

   Parse an Azure ML job object.

   :param job: AML object, definition of a job.
   :type job: Command

   :returns: The config of the job.
   :rtype: JobConfig


.. py:function:: parse_online_endpoint(endpoint: azure.ai.ml.entities.OnlineEndpoint) -> altametris.azure_ml_sdk.configs.models.OnlineEndpointConfig

   Parse an Azure ML online endpoint object.

   :param endpoint: AML object, definition of an online endpoint.
   :type endpoint: OnlineEndpoint

   :returns: The config of the online endpoint
   :rtype: OnlineEndpointConfig


.. py:function:: parse_online_deployment(deployment: azure.ai.ml.entities.OnlineDeployment) -> altametris.azure_ml_sdk.configs.models.OnlineDeploymentConfig

   Parse an Azure ML online deployment object.

   :param deployment: AML object, definition of an online deployment.
   :type deployment: OnlineDeployment

   :returns: The config of the online deployment.
   :rtype: OnlineDeploymentConfig