Statsmodels Statsmodels Formula Api Py At Main Github

Leo Migdal

-Dec 4, 2025, 7:42 AM

statsmodels statsmodels formula api py at main github

There was an error while loading. Please reload this page. The main statsmodels API is split into models: statsmodels.api: Cross-sectional models and methods. Canonically imported using import statsmodels.api as sm. statsmodels.tsa.api: Time-series models and methods.

Canonically imported using import statsmodels.tsa.api as tsa. statsmodels.formula.api: A convenience interface for specifying models using formula strings and DataFrames. This API directly exposes the from_formula class method of models that support the formula API. Canonically imported using import statsmodels.formula.api as smf The API focuses on models and the most frequently used statistical test, and tools. Import Paths and Structure explains the design of the two API modules and how importing from the API differs from directly importing from the module where the model is defined.

See the detailed topic pages in the User Guide for a complete list of available models, statistics, and tools. This document describes the Formula API in statsmodels, which provides an R-style formula interface for specifying statistical models. The Formula API allows users to express model specifications using a concise, string-based syntax rather than directly managing design matrices. This approach simplifies model creation and enhances readability by allowing users to focus on the statistical relationships rather than data manipulation details. For information about direct data management without formulas, see Data Management. The Formula API provides a consistent interface for specifying models using R-like formulas.

It leverages the patsy library for formula parsing and design matrix creation, which then feeds into statsmodels' model classes. Sources: statsmodels/formula/api.py12-32 The Formula API provides formula-based constructors for many statsmodels model classes. Each of these constructors is a convenience function that calls the from_formula method of the corresponding model class. Every tutorial you read shows a different way to import Statsmodels. One guide starts with import statsmodels.api as sm.

Another uses from statsmodels.formula.api import ols. A third imports directly from submodules like from statsmodels.regression.linear_model import OLS. Which approach should you use? The confusion stems from a deliberate design choice. Statsmodels offers multiple import paths because different users need different things. Researchers writing academic papers want one workflow.

Data scientists doing quick exploratory analysis want another. Understanding these three approaches will save you from blindly copying code that doesn’t match your actual needs. The statsmodels.api module serves as your main gateway to the library. When you import sm, you get access to the most commonly used models and functions through a clean namespace. Ordinary Least Squares becomes sm.OLS. Logistic regression becomes sm.Logit.

The add_constant function becomes sm.add_constant. The statsmodels.formula.api module gives you R-style formula syntax. Instead of manually separating your endog and exog variables, you write a formula string that describes the relationship. The lowercase function names (ols instead of OLS) signal that you’re using the formula interface. Direct imports pull specific classes or functions from their exact location in the library structure. You import only what you need, nothing more.

pip install statsmodels Copy PIP instructions Statistical computations and models for Python statsmodels is a Python package that provides a complement to scipy for statistical computations including descriptive statistics and estimation and inference for statistical models. The documentation for the latest release is at The documentation for the development version is at statsmodels is a Python package that provides a complement to scipy for statistical computations including descriptive statistics and estimation and inference for statistical models.

The documentation for the latest release is at The documentation for the development version is at Recent improvements are highlighted in the release notes https://www.statsmodels.org/stable/release/ Since version 0.5.0, statsmodels allows users to fit statistical models using R-style formulas. Internally, statsmodels uses the patsy package to convert formulas and data to the matrices that are used in model fitting.

The formula framework is quite powerful; this tutorial only scratches the surface. A full description of the formula language can be found in the patsy docs: You can import explicitly from statsmodels.formula.api Alternatively, you can just use the formula namespace of the main statsmodels.api. These names are just a convenient way to get access to each model’s from_formula classmethod. See, for instance

All of the lower case models accept formula and data arguments, whereas upper case ones take endog and exog design matrices. formula accepts a string which describes the model in terms of a patsy formula. data takes a pandas data frame or any other data structure that defines a __getitem__ for variable names like a structured array or a dictionary of variables. When diving into statistical modeling with Python’s powerful Statsmodels library, preparing your data can sometimes feel like a separate, time-consuming task. Manually creating dummy variables, interaction terms, or transformations often adds complexity before you even fit your first model. This is where the python statsmodels formula api shines!

Inspired by R’s elegant formula syntax, it provides a concise and intuitive way to define your models directly from a string, handled by the fantastic Patsy library under the hood. It simplifies your workflow, making your code cleaner and more readable. In this comprehensive guide, we’ll explore everything you need to know about the Statsmodels Formula API, from basic syntax to advanced transformations and interactions, empowering you to build sophisticated models with ease. The Statsmodels Formula API allows you to specify statistical models using a string-based formula, much like you would in R. This formula describes the relationship between your dependent (response) variable and your independent (predictor) variables. Its primary advantage is abstracting away the tedious data preparation steps.

It automatically handles tasks like creating design matrices, generating dummy variables for categorical features, and even constructing interaction terms, all based on a simple formula string. This drastically reduces boilerplate code and improves model interpretability. There was an error while loading. Please reload this page.

Statsmodels Statsmodels Formula Api Py At Main Github

People Also Search

There Was An Error While Loading. Please Reload This Page.

Canonically Imported Using Import Statsmodels.tsa.api As Tsa. Statsmodels.formula.api: A Convenience

See The Detailed Topic Pages In The User Guide For

It Leverages The Patsy Library For Formula Parsing And Design

Another Uses From Statsmodels.formula.api Import Ols. A Third Imports Directly