scvi.data.fields.CategoricalObsField
====================================

.. currentmodule:: scvi.data.fields

.. add toctree option to make autodoc generate the pages

.. autoclass:: CategoricalObsField



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

.. autosummary::

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





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

.. autosummary::

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





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



.. autoattribute:: CategoricalObsField.CATEGORICAL_MAPPING_KEY

.. autoattribute:: CategoricalObsField.ORIGINAL_ATTR_KEY

.. autoattribute:: CategoricalObsField.attr_key

.. autoattribute:: CategoricalObsField.attr_name

.. autoattribute:: CategoricalObsField.is_empty

.. autoattribute:: CategoricalObsField.mod_key

.. autoattribute:: CategoricalObsField.registry_key






Methods
~~~~~~~



.. automethod:: CategoricalObsField.get_data_registry

.. automethod:: CategoricalObsField.get_field_data

.. automethod:: CategoricalObsField.get_summary_stats

.. automethod:: CategoricalObsField.register_field

.. automethod:: CategoricalObsField.transfer_field

.. automethod:: CategoricalObsField.validate_field

.. automethod:: CategoricalObsField.view_state_registry