Model Family ============================= .. py:module:: evalml.model_family .. autoapi-nested-parse:: Family of machine learning models. Submodules ---------- .. toctree:: :titlesonly: :maxdepth: 1 model_family/index.rst utils/index.rst Package Contents ---------------- Classes Summary ~~~~~~~~~~~~~~~ .. autoapisummary:: evalml.model_family.ModelFamily Functions ~~~~~~~~~ .. autoapisummary:: :nosignatures: evalml.model_family.handle_model_family Contents ~~~~~~~~~~~~~~~~~~~ .. py:function:: handle_model_family(model_family) Handles model_family by either returning the ModelFamily or converting from a string. :param model_family: Model type that needs to be handled. :type model_family: str or ModelFamily :returns: ModelFamily :raises KeyError: If input is not a valid model family. :raises ValueError: If input is not a string or ModelFamily object. .. py:class:: ModelFamily Enum for family of machine learning models. **Attributes** .. list-table:: :widths: 15 85 :header-rows: 0 * - **ARIMA** - ARIMA model family. * - **BASELINE** - Baseline model family. * - **CATBOOST** - CatBoost model family. * - **DECISION_TREE** - Decision Tree model family. * - **ENSEMBLE** - Ensemble model family. * - **EXPONENTIAL_SMOOTHING** - Exponential Smoothing model family. * - **EXTRA_TREES** - Extra Trees model family. * - **K_NEIGHBORS** - K Nearest Neighbors model family. * - **LIGHTGBM** - LightGBM model family. * - **LINEAR_MODEL** - Linear model family. * - **NONE** - None * - **PROPHET** - Prophet model family. * - **RANDOM_FOREST** - Random Forest model family. * - **SVM** - SVM model family. * - **VOWPAL_WABBIT** - Vowpal Wabbit model family. * - **XGBOOST** - XGBoost model family. **Methods** .. autoapisummary:: :nosignatures: evalml.model_family.ModelFamily.is_tree_estimator evalml.model_family.ModelFamily.name evalml.model_family.ModelFamily.value .. py:method:: is_tree_estimator(self) Checks whether the estimator's model family uses trees. .. py:method:: name(self) The name of the Enum member. .. py:method:: value(self) The value of the Enum member.