JuliaDynamics / JuliaDynamics/NonlinearDynamicsTextbook
Add more details on the summation in the mutual information formula
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 266
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
After working with students on using mutual information, and referring them to our book, I realized that it was not clear to them what the summants n, m are in equation 7.1. The summation goes over bins, while the students were summing over the indices of x and y.
I think our text does not explain enough the MI. It defines it and proceeds immediatelly to discuss its properties, but I think we should spend a couple of sentences discussing what the summation means and how one does it in practice.
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 at equation 7.1 and review the surrounding mutual-information discussion. Clarify that n and m range over bins rather than the indices of x and y, and add a brief explanation of how the summation is carried out in practice; no file or test is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100