.. _model:



Internal Classes
================

The following summarizes classes and functions that are not intended to be
directly used, but of interest only for internal use or for a developer who
wants to extend on existing model classes.


Module Reference
----------------

Model and Results Classes
^^^^^^^^^^^^^^^^^^^^^^^^^

These are the base classes for both the estimation models and the results.
They are not directly useful, but layout the structure of the subclasses and
define some common methods.

.. module:: statsmodels.base.model
   :synopsis: Base classes that are inherited by models

.. currentmodule:: statsmodels.base.model

.. autosummary::
   :toctree: generated/

   Model
   LikelihoodModel
   GenericLikelihoodModel
   Results
   LikelihoodModelResults
   ResultMixin
   GenericLikelihoodModelResults

.. module:: statsmodels.stats.contrast
   :synopsis: Classes for statistical test

.. currentmodule:: statsmodels.stats.contrast

.. autosummary::
   :toctree: generated/

   ContrastResults

.. inheritance-diagram:: statsmodels.base.model statsmodels.discrete.discrete_model statsmodels.regression.linear_model statsmodels.miscmodels.count
   :parts: 3

.. inheritance-diagram:: statsmodels.regression.linear_model.GLS statsmodels.regression.linear_model.WLS statsmodels.regression.linear_model.OLS statsmodels.regression.linear_model.GLSAR
   :parts: 1

Linear Model
^^^^^^^^^^^^

.. inheritance-diagram:: statsmodels.regression.linear_model
   :parts: 1

Generalized Linear Model
^^^^^^^^^^^^^^^^^^^^^^^^

.. inheritance-diagram:: statsmodels.genmod.generalized_linear_model
   statsmodels.genmod.families.family statsmodels.genmod.families.links
   :parts: 1

Discrete Model
^^^^^^^^^^^^^^

.. inheritance-diagram:: statsmodels.discrete.discrete_model
   :parts: 1

Robust Model
^^^^^^^^^^^^

.. inheritance-diagram:: statsmodels.robust.robust_linear_model
   :parts: 1

Vector Autoregressive Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. inheritance-diagram:: statsmodels.tsa.vector_ar.var_model
   :parts: 3
