statsmodels / statsmodels/statsmodels

documentation: add brief description of general features of models

Open
#653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

comp-base comp-docs
Dominant language
Python
Stars
11.6k
Forks
3.6k
Avg merge
7h 37m
Merged PRs (30d)
96

Description

I think we should add a new section with a brief descriptions features that are the same across models.

The case I have in mind is the description of the new nan/missing value handling.
It's described in the docstrings (I guess), but I would like to add a section BEWARE to it.
The advantages of cleaning first: You need to do it only once, if the same model is estimated repeatedly (no repeated checking and array copying). When we run regression with different number of exog variables/columns, then the number of observations can differ after removing missing observations in each exog. This is good in some cases, but not when we want to compare (nested) models.

other features ?

  • pickle for prediction :?
  • constant handling : cleaned up in 0.5
  • t versus normal distribution in tests/postestimation inference

I don't remember if or where those are already described.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing model docstrings and documentation for nan/missing-value handling, constant handling, pickle-based prediction, and t versus normal distributions in tests and postestimation inference. Done means adding a clearly scoped general-features section, including the requested missing-value warning and any confirmed cross-model features.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.