plaid.storage.registry
======================

.. py:module:: plaid.storage.registry

.. autoapi-nested-parse::

   Backend registry for plaid.storage.

   This module centralizes backend wiring so reader/writer code can use a single
   source of truth for backend capabilities.



Attributes
----------

.. autoapisummary::

   plaid.storage.registry.BACKENDS


Classes
-------

.. autoapisummary::

   plaid.storage.registry.BackendSpec


Functions
---------

.. autoapisummary::

   plaid.storage.registry.available_backends
   plaid.storage.registry.get_backend


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

.. py:class:: BackendSpec

   Backend wiring for storage operations.


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


   .. py:attribute:: init_from_disk
      :type:  Callable[[Union[str, pathlib.Path]], Union[plaid.storage.cgns.reader.CGNSDatasetDict, plaid.storage.hf_datasets.reader.HFDatasetDict, plaid.storage.zarr.reader.ZarrDatasetDict]]


   .. py:attribute:: download_from_hub
      :type:  Callable[Ellipsis, str]


   .. py:attribute:: init_streaming_from_hub
      :type:  Callable[Ellipsis, dict[str, datasets.IterableDataset] | datasets.IterableDatasetDict]


   .. py:attribute:: generate_to_disk
      :type:  Callable[Ellipsis, None]


   .. py:attribute:: push_local_to_hub
      :type:  Callable[Ellipsis, None]


   .. py:attribute:: configure_dataset_card
      :type:  Callable[Ellipsis, None]


   .. py:attribute:: to_var_sample_dict
      :type:  Optional[Callable[Ellipsis, dict[str, Any]]]


   .. py:attribute:: sample_to_var_sample_dict
      :type:  Optional[Callable[Ellipsis, dict[str, Any]]]


.. py:data:: BACKENDS

.. py:function:: available_backends() -> list[str]

   Return available backend names in stable order.


.. py:function:: get_backend(name: str) -> BackendSpec

   Return the backend spec for a given name.