.. note::

   This page is a reference documentation. It only explains the function signature, and not how to use it.
   Please refer to the :ref:`What you really need to know <need_to_know>` section for the big picture.

.. warning::
   This function is experimental. This means that it may change in the future
   and the documentation is not complete. Particularly, the dependencies on
   which this function relies might be beta releases of other packages.

{{ fullname | underline(line="-") }}

.. currentmodule:: {{ module }}

.. autofunction:: {{ objname }}

.. _sphx_glr_backreferences_{{ fullname }}:

.. minigallery:: {{fullname}}.{{item}}
    :add-heading:


.. raw:: html

    <div style='clear:both'></div>
