scvi.data.fields.CategoricalVarField
====================================

.. currentmodule:: scvi.data.fields

.. add toctree option to make autodoc generate the pages

.. autoclass:: CategoricalVarField



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

.. autosummary::

    ~scvi.data.fields.CategoricalVarField.CATEGORICAL_MAPPING_KEY
    ~scvi.data.fields.CategoricalVarField.ORIGINAL_ATTR_KEY
    ~scvi.data.fields.CategoricalVarField.attr_key
    ~scvi.data.fields.CategoricalVarField.attr_name
    ~scvi.data.fields.CategoricalVarField.is_empty
    ~scvi.data.fields.CategoricalVarField.mod_key
    ~scvi.data.fields.CategoricalVarField.registry_key





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

.. autosummary::

    ~scvi.data.fields.CategoricalVarField.get_data_registry
    ~scvi.data.fields.CategoricalVarField.get_field_data
    ~scvi.data.fields.CategoricalVarField.get_summary_stats
    ~scvi.data.fields.CategoricalVarField.register_field
    ~scvi.data.fields.CategoricalVarField.transfer_field
    ~scvi.data.fields.CategoricalVarField.validate_field
    ~scvi.data.fields.CategoricalVarField.view_state_registry





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



.. autoattribute:: CategoricalVarField.CATEGORICAL_MAPPING_KEY

.. autoattribute:: CategoricalVarField.ORIGINAL_ATTR_KEY

.. autoattribute:: CategoricalVarField.attr_key

.. autoattribute:: CategoricalVarField.attr_name

.. autoattribute:: CategoricalVarField.is_empty

.. autoattribute:: CategoricalVarField.mod_key

.. autoattribute:: CategoricalVarField.registry_key






Methods
~~~~~~~



.. automethod:: CategoricalVarField.get_data_registry

.. automethod:: CategoricalVarField.get_field_data

.. automethod:: CategoricalVarField.get_summary_stats

.. automethod:: CategoricalVarField.register_field

.. automethod:: CategoricalVarField.transfer_field

.. automethod:: CategoricalVarField.validate_field

.. automethod:: CategoricalVarField.view_state_registry