﻿scvi.data.fields.BaseAnnDataField
=================================

.. currentmodule:: scvi.data.fields

.. add toctree option to make autodoc generate the pages

.. autoclass:: BaseAnnDataField



Attributes table
~~~~~~~~~~~~~~~~~~

.. autosummary::

    ~BaseAnnDataField.attr_key
    ~BaseAnnDataField.attr_name
    ~BaseAnnDataField.is_empty
    ~BaseAnnDataField.mod_key
    ~BaseAnnDataField.registry_key





Methods table
~~~~~~~~~~~~~

.. autosummary::

    ~BaseAnnDataField.get_data_registry
    ~BaseAnnDataField.get_field_data
    ~BaseAnnDataField.get_summary_stats
    ~BaseAnnDataField.register_field
    ~BaseAnnDataField.transfer_field
    ~BaseAnnDataField.validate_field
    ~BaseAnnDataField.view_state_registry





Attributes
~~~~~~~~~~~



.. autoattribute:: BaseAnnDataField.attr_key

.. autoattribute:: BaseAnnDataField.attr_name

.. autoattribute:: BaseAnnDataField.is_empty

.. autoattribute:: BaseAnnDataField.mod_key

.. autoattribute:: BaseAnnDataField.registry_key






Methods
~~~~~~~



.. automethod:: BaseAnnDataField.get_data_registry

.. automethod:: BaseAnnDataField.get_field_data

.. automethod:: BaseAnnDataField.get_summary_stats

.. automethod:: BaseAnnDataField.register_field

.. automethod:: BaseAnnDataField.transfer_field

.. automethod:: BaseAnnDataField.validate_field

.. automethod:: BaseAnnDataField.view_state_registry


