models
======

.. py:module:: models


Classes
-------

.. autoapisummary::

   models.AzureMLBaseConfig
   models.ComponentConfig
   models.PipelineConfig
   models.JobConfig
   models.OnlineEndpointConfig
   models.OnlineDeploymentConfig


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

.. py:class:: AzureMLBaseConfig

   Bases: :py:obj:`pydantic.BaseModel`


   Base configuration for Azure Machine Learning configurations (YAML files).


   .. py:attribute:: entity
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: description
      :type:  Optional[str]
      :value: None



.. py:class:: ComponentConfig

   Bases: :py:obj:`AzureMLBaseConfig`


   Component config class.


   .. py:attribute:: entity
      :type:  Literal['component']


   .. py:attribute:: environment
      :type:  str


   .. py:attribute:: compute
      :type:  Optional[str]
      :value: None



   .. py:attribute:: command
      :type:  str


   .. py:attribute:: inputs
      :type:  Optional[dict]
      :value: None



   .. py:attribute:: outputs
      :type:  Optional[dict]
      :value: None



.. py:class:: PipelineConfig

   Bases: :py:obj:`AzureMLBaseConfig`


   Pipeline config class.


   .. py:attribute:: entity
      :type:  Literal['pipeline']


   .. py:attribute:: jobs
      :type:  List[ComponentConfig]


   .. py:attribute:: default_compute
      :type:  Optional[str]
      :value: None



   .. py:attribute:: inputs
      :type:  Optional[dict]
      :value: None



   .. py:attribute:: outputs
      :type:  Optional[dict]
      :value: None



.. py:class:: JobConfig

   Bases: :py:obj:`AzureMLBaseConfig`


   Job config class.


   .. py:attribute:: entity
      :type:  Literal['job']


   .. py:attribute:: environment
      :type:  str


   .. py:attribute:: compute
      :type:  str


   .. py:attribute:: command
      :type:  str


   .. py:attribute:: inputs
      :type:  Optional[dict]
      :value: None



   .. py:attribute:: outputs
      :type:  Optional[dict]
      :value: None



.. py:class:: OnlineEndpointConfig

   Bases: :py:obj:`AzureMLBaseConfig`


   Online endpoint config class.


   .. py:attribute:: entity
      :type:  Literal['online_endpoint']


   .. py:attribute:: auth_mode
      :type:  Literal['key', 'aad']


.. py:class:: OnlineDeploymentConfig

   Bases: :py:obj:`AzureMLBaseConfig`


   Online deployment config class.


   .. py:attribute:: entity
      :type:  Literal['online_deployment']


   .. py:attribute:: endpoint_name
      :type:  str


   .. py:attribute:: model
      :type:  str


   .. py:attribute:: scoring_path
      :type:  str


   .. py:attribute:: scoring_script
      :type:  str


   .. py:attribute:: environment
      :type:  str


   .. py:attribute:: instance_type
      :type:  str


   .. py:attribute:: instance_count
      :type:  int