sequince_density.flows.coppuccino
=================================

.. py:module:: sequince_density.flows.coppuccino

.. autoapi-nested-parse::

   Eager copula normalizing flows backed by Coppuccino.



Classes
-------

.. autoapisummary::

   sequince_density.flows.coppuccino.CoppuccinoFlow


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

.. py:class:: CoppuccinoFlow(dims, *, seed = 0, particle_transform = None, dtype = None, device = None, **kwargs)

   Bases: :py:obj:`sequince_density.flows.base.Flow`


   Fit one copula flow with unbounded marginals.

   :param dims: Number of columns in the training and scoring arrays.
   :type dims: int
   :param seed: Seed for calls without an explicit RNG.
   :type seed: int, default=0
   :param particle_transform: Outer coordinate transform. Bounded-to-unbounded and periodic
                              transforms are unsupported.
   :type particle_transform: ParticleTransform, optional
   :param dtype: If supplied, must be float64. The eager API uses NumPy float64.
   :type dtype: dtype, optional
   :param device: Accepted for compatibility. JAX controls internal device placement.
   :type device: optional
   :param \*\*kwargs: Coppuccino training options, such as `flow_layers` or `max_epochs`.


   .. py:attribute:: xp


   .. py:method:: fit(samples, context = None, *, rng = None, **kwargs)

      Fit to a finite array of shape `(n_samples, dims)`.



   .. py:method:: forward(samples, context = None)

      Map particles to the base space with their log-Jacobian.



   .. py:method:: inverse(samples, context = None)

      Map base-space points to particle space with their log-Jacobian.



   .. py:method:: log_prob(samples, context = None)

      Return the log density of each point in particle space.



   .. py:method:: sample(n_samples, context = None, *, rng = None)

      Draw an array with shape `(n_samples, dims)`.



   .. py:method:: sample_and_log_prob(n_samples, context = None, *, rng = None)

      Draw particles and return their log densities in particle space.



   .. py:method:: state_dict()

      Capture the fitted model, outer transform, and local RNG state.



   .. py:method:: load_state_dict(state)

      Restore state from a trusted checkpoint.



