crabbymetrics
  • Home
  • API
    • API Overview
    • Regression And GLMs
    • OLS
    • Ridge
    • FixedEffectsOLS
    • ElasticNet
    • Logit
    • MultinomialLogit
    • Poisson
    • FTRL
    • Causal Inference And Panels
    • TwoSLS
    • BalancingWeights
    • EPLM
    • AverageDerivative
    • PartiallyLinearDML
    • AIPW
    • SyntheticControl
    • HorizontalPanelRidge
    • SyntheticDID
    • MatrixCompletion
    • InteractiveFixedEffects
    • Transforms
    • PCA
    • KernelBasis
    • Estimation Interfaces
    • GMM
    • MEstimator
    • Optimizers
  • Binding Crash Course
  • Regression And GLMs
    • OLS
    • Ridge
    • Fixed Effects OLS
    • ElasticNet
    • Logit
    • Multinomial Logit
    • Poisson
    • GMM
    • FTRL
    • MEstimator Poisson
  • Causal Inference
    • Balancing Weights
    • EPLM
    • Average Derivative
    • Double ML And AIPW
    • Richer Regression
    • TwoSLS
    • Synthetic Control
    • Synthetic DID
    • Horizontal Panel Ridge
    • Matrix Completion
    • Interactive Fixed Effects
    • Staggered Panel Event Study
  • Transforms
    • PCA And Kernel Basis
  • Ablations
    • Variance Estimators
    • Semiparametric Estimator Comparisons
    • Two-Period Semiparametric DID
    • Bridging Finite And Superpopulation
    • Panel Estimator DGP Comparisons
    • Same Root Panel Case Studies
    • Randomized Sketching And Least Squares
  • Optimization
    • Optimizers
    • GMM With Optimizers
  • Ding: First Course
    • Overview And TOC
    • Ch 1 Correlation And Simpson
    • Ch 2 Potential Outcomes
    • Ch 3 CRE And Fisher RT
    • Ch 4 CRE And Neyman
    • Ch 9 Bridging Finite And Superpopulation
    • Ch 11 Propensity Score
    • Ch 12 Double Robust ATE
    • Ch 13 Double Robust ATT
    • Ch 21 Experimental IV
    • Ch 23 Econometric IV
    • Ch 27 Mediation

On this page

  • 1 Where it fits
  • 2 Python API
  • 3 Minimal example
  • 4 summary() contract

Logit

Binary logistic regression

from _api_doc_utils import *

1 Where it fits

Group: Regression

Logit models a binary outcome through

\[ \Pr(Y_i=1\mid X_i=x_i)=\Lambda(\alpha+x_i'\beta), \]

with optional L2 regularization controlled by alpha. predict(x) returns class labels, not probabilities.

2 Python API

Constructor: cm.Logit

Fit with integer labels using fit(x, y_int32). summary() returns intercept/coefficient estimates and Fisher-information standard errors. bootstrap() resamples observations and refits the classifier.

print(inspect.signature(cm.Logit))
(alpha=1.0, max_iterations=100, gradient_tolerance=0.0001)
cls = cm.Logit
display(HTML(html_table(["Public method"], public_methods(cls))))
Public method
bootstrap(self, /, n_bootstrap, seed=None)
fit(self, /, x, y)
predict(self, /, x)
summary(self, /)

3 Minimal example

rng=np.random.default_rng(5)
x=rng.normal(size=(220,3)); eta=-0.2+x@np.array([.7,-.4,.9]); p=1/(1+np.exp(-eta))
y=rng.binomial(1,p,size=220).astype(np.int32)
model=cm.Logit(max_iterations=200); model.fit(x,y)
print(model.summary()["coef"])
print(model.predict(x[:5]))
[ 0.54200057 -0.56624631  0.82327844]
[1 0 1 0 0]

4 summary() contract

The table below is generated by fitting the live class in this repository and then inspecting summary(). Shapes are shown because most values are plain NumPy arrays or scalars.

rng=np.random.default_rng(105); x=rng.normal(size=(90,3)); p=1/(1+np.exp(-(x@np.array([.7,-.4,.9])))); y=rng.binomial(1,p,size=90).astype(np.int32)
model=cm.Logit(max_iterations=200); model.fit(x,y)
summary = model.summary()
display(HTML(html_table(["summary() key", "shape"], summary_shape_rows(summary))))
summary() key shape
intercept ()
coef (3,)
intercept_se ()
coef_se (3,)