scvi.module.AmortizedLDAPyroModule#
- class scvi.module.AmortizedLDAPyroModule(n_input, n_topics, n_hidden, cell_topic_prior=None, topic_feature_prior=None)[source]#
Bases:
scvi.module.base._base_module.PyroBaseModuleClassAn amortized implementation of Latent Dirichlet Allocation [Blei03] implemented in Pyro.
This module uses auto encoding variational Bayes to optimize the latent variables in the model. In particular, a fully-connected neural network is used as an encoder, which takes in feature counts as input and outputs the parameters of cell topic distribution. To employ the reparametrization trick stably, the Dirichlet priors are approximated by a Logistic-Normal distribution. The input feature counts tensor is a cell by features Bag-of-Words(BoW) representation of the counts. I.e. the model treats each cell’s feature vector as ordered, not as unordered as in a Multinomial distribution.
- Parameters
- n_input :
int Number of input features.
- n_topics :
int Number of topics/topics to model.
- n_hidden :
int Number of nodes in the hidden layer of the encoder.
- cell_topic_prior :
float|Sequence[float] |NoneUnion[float,Sequence[float],None] (default:None) Prior of cell topic distribution. If None, defaults to 1 / n_topics.
- topic_feature_prior :
float|Sequence[float] |NoneUnion[float,Sequence[float],None] (default:None) Prior of topic feature distribution. If None, defaults to 1 / n_topics.
- n_input :
Attributes table#
Methods table#
|
Computes ELBO. |
|
Converts x to its inferred topic distribution. |
|
Gets a Monte-Carlo estimate of the expectation of the topic by feature matrix. |
Attributes#
T_destination#
- AmortizedLDAPyroModule.T_destination#
alias of TypeVar(‘T_destination’, bound=
Mapping[str,torch.Tensor])
alias of TypeVar(‘T_destination’, bound=Mapping[str, torch.Tensor])
.. autoattribute:: AmortizedLDAPyroModule.T_destination
dump_patches
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- AmortizedLDAPyroModule.dump_patches: bool = False#
This allows better BC support for
load_state_dict(). Instate_dict(), the version number will be saved as in the attribute _metadata of the returned state dict, and thus pickled. _metadata is a dictionary with keys that follow the naming convention of state dict. See_load_from_state_dicton how to use this information in loading.If new parameters/buffers are added/removed from a module, this number shall be bumped, and the module’s _load_from_state_dict method can compare the version number and do appropriate changes if the state dict is from before the change.
guide#
- AmortizedLDAPyroModule.guide#
list_obs_plate_vars#
- AmortizedLDAPyroModule.list_obs_plate_vars#
Model annotation for minibatch training with pyro plate.
A dictionary with: 1. “name” - the name of observation/minibatch plate; 2. “in” - indexes of model args to provide to encoder network when using amortised inference; 3. “sites” - dictionary with
- keys - names of variables that belong to the observation plate (used to recognise
and merge posterior samples for minibatch variables)
- values - the dimensions in non-plate axis of each variable (used to construct output
layer of encoder network when using amortised inference)
model#
- AmortizedLDAPyroModule.model#