statsmodels / statsmodels/statsmodels

FAQ-D: debugging problems with results attributes

Open
#2,400 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When writing statsmodels code that works with results instances that are not self, we need to watch out that we don't have the wrapper.

I just reset the scale

res.scale = something

and debugged for an hour, why cov_params didn't change, even though res.scale showed the correct something

Problem:

Setting an attribute of a wrapped results instance, adds this attribute to the wrapper and not to the underlying result instance, res._results

Make sure we have the right res._results to manipulate.

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

Start with FAQ-D and locate the wrapped-results implementation referenced by the issue. Read how res, res._results, res.scale, and cov_params relate, then clarify the documented handling of attributes on wrapped results and define completion by making the debugging guidance unambiguous.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.