ml_switcheroo.frameworks
========================

.. py:module:: ml_switcheroo.frameworks

.. autoapi-nested-parse::

   Framework Adapters Package.

   Automatically discovers and registers framework adapters.
   Exposes concrete Adapter classes for testing/typing convenience.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /api/ml_switcheroo/frameworks/base/index
   /api/ml_switcheroo/frameworks/common/index
   /api/ml_switcheroo/frameworks/flax_nnx/index
   /api/ml_switcheroo/frameworks/jax/index
   /api/ml_switcheroo/frameworks/keras/index
   /api/ml_switcheroo/frameworks/mlx/index
   /api/ml_switcheroo/frameworks/numpy/index
   /api/ml_switcheroo/frameworks/optax_shim/index
   /api/ml_switcheroo/frameworks/paxml/index
   /api/ml_switcheroo/frameworks/tensorflow/index
   /api/ml_switcheroo/frameworks/torch/index


Attributes
----------

.. autoapisummary::

   ml_switcheroo.frameworks.TorchAdapter
   ml_switcheroo.frameworks.JaxAdapter
   ml_switcheroo.frameworks.FlaxNNXAdapter
   ml_switcheroo.frameworks.PaxmlAdapter
   ml_switcheroo.frameworks.NumpyAdapter
   ml_switcheroo.frameworks.TensorFlowAdapter
   ml_switcheroo.frameworks.MLXAdapter


Classes
-------

.. autoapisummary::

   ml_switcheroo.frameworks.FrameworkAdapter


Functions
---------

.. autoapisummary::

   ml_switcheroo.frameworks.register_framework
   ml_switcheroo.frameworks.get_adapter
   ml_switcheroo.frameworks.available_frameworks


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

.. py:class:: FrameworkAdapter

   Bases: :py:obj:`Protocol`


   Protocol definition for a Framework Adapter.


   .. py:method:: convert(data: Any) -> Any


   .. py:property:: test_config
      :type: Dict[str, str]



   .. py:property:: search_modules
      :type: List[str]



   .. py:property:: display_name
      :type: str



   .. py:property:: ui_priority
      :type: int



   .. py:property:: discovery_heuristics
      :type: Dict[str, List[str]]



   .. py:property:: supported_tiers
      :type: List[ml_switcheroo.enums.SemanticTier]



   .. py:property:: import_alias
      :type: Tuple[str, str]



   .. py:property:: inherits_from
      :type: Optional[str]



   .. py:property:: structural_traits
      :type: ml_switcheroo.semantics.schema.StructuralTraits



   .. py:property:: rng_seed_methods
      :type: List[str]



   .. py:method:: get_device_syntax(device_type: str, device_index: Optional[str] = None) -> str


   .. py:method:: get_serialization_syntax(op: str, file_arg: str, object_arg: Optional[str] = None) -> str


   .. py:method:: get_serialization_imports() -> List[str]


   .. py:method:: get_example_code() -> str
      :classmethod:



   .. py:method:: get_tiered_examples() -> Dict[str, str]


   .. py:property:: definitions
      :type: Dict[str, StandardMap]


      Returns the framework's static implementation of Middle Layer Operations.


   .. py:property:: import_namespaces
      :type: Dict[str, Dict[str, str]]


      Returns import path remapping rules.
      Format: {"source.mod": {"root": "target", "sub": "mod", "alias": "alias"}}


   .. py:method:: collect_api(category: StandardCategory) -> List[ml_switcheroo.core.ghost.GhostRef]


   .. py:method:: apply_wiring(snapshot: Dict[str, Any]) -> None


.. py:function:: register_framework(name: str)

.. py:function:: get_adapter(name: str) -> Optional[FrameworkAdapter]

.. py:data:: TorchAdapter
   :value: None


.. py:data:: JaxAdapter
   :value: None


.. py:data:: FlaxNNXAdapter
   :value: None


.. py:data:: PaxmlAdapter
   :value: None


.. py:data:: NumpyAdapter
   :value: None


.. py:data:: TensorFlowAdapter
   :value: None


.. py:data:: MLXAdapter
   :value: None


.. py:function:: available_frameworks() -> List[str]

   Returns a list of all registered framework keys.