neurostuff / neurostuff/PyMARE
Merge `Estimator.summary()` and `Estimator.fit()`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 58
- Forks
- 16
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
In PyMARE, fit and fit_dataset both return Estimators, rather than Results. Instead, there's an additional step of calling Estimator.summary() to produce the Results object. This is different from NiMARE, where fitting an Estimator returns a MetaResult.
I don't know if the extra step is necessary. I.e., does fit returning an Estimator instead of a Result serve a purpose?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing Estimator.fit(), fit_dataset(), and summary() to understand what each returns and whether the extra summary step serves a purpose. Compare this behavior with the NiMARE fitting flow described in the issue. The work is done when the return-value design is decided and the issue's API question is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100