AllenInstitute / AllenInstitute/AllenSDK
units of GLIF parameters hard to find
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 398
- Forks
- 163
- PR merge metrics
- No merged PRs in 30d
Description
Hey,
first I have a question: Is it true that the parameters that you get from get_neuron_config() are the fitted values as described by the fitting procedure in the glif white paper ?
Further I wanted to suggest to put the units of the parameters maybe into a second dictionairy with the same keys as the neuron_config dict because if you overlooked them on the website, as I did, it's not so obvious where to find them. Another alternative that I find more intuitive would be the api docs.
Also, I couldn't figure out yet what to do with the neuron.coeffs (also returned by get_neuron_config()), do I have to multiply them to the parameters with the same name ? Did I just miss something in the white paper ?
Cheers,
awakenting
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 with get_neuron_config(), neuron.coeffs, and the GlifNeuron API documentation linked in the issue. Compare the parameter descriptions with the GLIF white paper and glif_models.html. Done means the parameter units and the role of coeffs are documented where users can find them, with the fitted-value question answered.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100