component_base_meta
=========================================================

.. py:module:: evalml.pipelines.components.component_base_meta

.. autoapi-nested-parse::

   Metaclass that overrides creating a new component by wrapping methods with validators and setters.



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

Classes Summary
~~~~~~~~~~~~~~~

.. autoapisummary::

   evalml.pipelines.components.component_base_meta.ComponentBaseMeta





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: ComponentBaseMeta



   Metaclass that overrides creating a new component by wrapping methods with validators and setters.


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **FIT_METHODS**
        - ['fit', 'fit_transform']
      * - **METHODS_TO_CHECK**
        - ['predict', 'predict_proba', 'transform', 'inverse_transform', 'get_trend_dataframe']
      * - **PROPERTIES_TO_CHECK**
        - ['feature_importance']


   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.pipelines.components.component_base_meta.ComponentBaseMeta.check_for_fit
      evalml.pipelines.components.component_base_meta.ComponentBaseMeta.register
      evalml.pipelines.components.component_base_meta.ComponentBaseMeta.set_fit

   .. py:method:: check_for_fit(cls, method)
      :classmethod:

      `check_for_fit` wraps a method that validates if `self._is_fitted` is `True`.

      It raises an exception if `False` and calls and returns the wrapped method if `True`.

      :param method: Method to wrap.
      :type method: callable

      :returns: The wrapped method.

      :raises ComponentNotYetFittedError: If component is not yet fitted.


   .. py:method:: register(cls, subclass)

      Register a virtual subclass of an ABC.

      Returns the subclass, to allow usage as a class decorator.


   .. py:method:: set_fit(cls, method)
      :classmethod:

      Wrapper for the fit method.