:py:mod:`neural_compressor.compression.pruner.patterns`
=======================================================

.. py:module:: neural_compressor.compression.pruner.patterns

.. autoapi-nested-parse::

   Pruners.



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   base/index.rst
   mha/index.rst
   ninm/index.rst
   nxm/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   neural_compressor.compression.pruner.patterns.get_pattern



.. py:function:: get_pattern(config, modules, framework='pytorch')

   Get registered pattern class.

   Get a Pattern object from PATTERNS.

   :param config: A config dict object that contains the pattern information.
   :param modules: Torch neural network modules to be pruned with the pattern.

   :returns: A Pattern object.

   :raises AssertionError: Currently only support patterns which have been registered in PATTERNS.