:py:mod:`anomalib.config`
=========================

.. py:module:: anomalib.config

.. autoapi-nested-parse::

   Utilities for parsing model configuration.



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   config/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   anomalib.config.get_configurable_parameters
   anomalib.config.update_input_size_config
   anomalib.config.update_nncf_config



.. py:function:: get_configurable_parameters(model_name: Optional[str] = None, config_path: Optional[Union[pathlib.Path, str]] = None, weight_file: Optional[str] = None, config_filename: Optional[str] = 'config', config_file_extension: Optional[str] = 'yaml') -> Union[omegaconf.DictConfig, omegaconf.ListConfig]

   Get configurable parameters.

   :param model_name: Optional[str]:  (Default value = None)
   :param config_path: Optional[Union[Path, str]]:  (Default value = None)
   :param weight_file: Path to the weight file
   :param config_filename: Optional[str]:  (Default value = "config")
   :param config_file_extension: Optional[str]:  (Default value = "yaml")

   :returns: Configurable parameters in DictConfig object.
   :rtype: Union[DictConfig, ListConfig]


.. py:function:: update_input_size_config(config: Union[omegaconf.DictConfig, omegaconf.ListConfig]) -> Union[omegaconf.DictConfig, omegaconf.ListConfig]

   Update config with image size as tuple, effective input size and tiling stride.

   Convert integer image size parameters into tuples, calculate the effective input size based on image size
   and crop size, and set tiling stride if undefined.

   :param config: Configurable parameters object
   :type config: Union[DictConfig, ListConfig]

   :returns: Configurable parameters with updated values
   :rtype: Union[DictConfig, ListConfig]


.. py:function:: update_nncf_config(config: Union[omegaconf.DictConfig, omegaconf.ListConfig]) -> Union[omegaconf.DictConfig, omegaconf.ListConfig]

   Set the NNCF input size based on the value of the crop_size parameter in the configurable parameters object.

   :param config: Configurable parameters of the current run.
   :type config: Union[DictConfig, ListConfig]

   :returns: Updated configurable parameters in DictConfig object.
   :rtype: Union[DictConfig, ListConfig]