plaid.constants
===============

.. py:module:: plaid.constants

.. autoapi-nested-parse::

   This module defines common constants used throughout the PLAID library.

   It includes:
   - AUTHORIZED_TASKS: List of supported task types (e.g., regression, classification).
   - AUTHORIZED_FEATURE_TYPES: List of supported feature types (e.g., scalar, field, nodes).
   - AUTHORIZED_FEATURE_INFOS: Dictionary specifying allowed metadata keys for various feature types.
   - AUTHORIZED_INFO_KEYS: Dictionary specifying allowed metadata keys for various information sections.
   - CGNS_FIELD_LOCATIONS: List of valid field locations as defined by the CGNS standard.
   - CGNS_ELEMENT_NAMES: List of CGNS element names representing different mesh element types.

   These constants help standardize metadata, task types, and mesh element references across the PLAID codebase.



Attributes
----------

.. autoapisummary::

   plaid.constants.AUTHORIZED_TASKS
   plaid.constants.AUTHORIZED_SCORE_FUNCTIONS
   plaid.constants.AUTHORIZED_FEATURE_TYPES
   plaid.constants.AUTHORIZED_FEATURE_INFOS
   plaid.constants.AUTHORIZED_INFO_KEYS
   plaid.constants.CGNS_FIELD_LOCATIONS
   plaid.constants.CGNS_ELEMENT_NAMES


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

.. py:data:: AUTHORIZED_TASKS
   :value: ['regression', 'classification']


.. py:data:: AUTHORIZED_SCORE_FUNCTIONS
   :value: ['RRMSE']


.. py:data:: AUTHORIZED_FEATURE_TYPES
   :value: ['scalar', 'field', 'nodes']


.. py:data:: AUTHORIZED_FEATURE_INFOS

.. py:data:: AUTHORIZED_INFO_KEYS

.. py:data:: CGNS_FIELD_LOCATIONS
   :value: ['Vertex', 'CellCenter', 'FaceCenter', 'IFaceCenter', 'JFaceCenter', 'KFaceCenter', 'EdgeCenter']


.. py:data:: CGNS_ELEMENT_NAMES
   :value: ['ElementTypeNull', 'ElementTypeUserDefined', 'NODE', 'BAR_2', 'BAR_3', 'TRI_3', 'TRI_6',...