This PR does not change any functional part of the code.
Instead, it
Updates the available_similarity_measures list in sim.py
Fixes a lot of typos in the docstrings.
Swaps the place of some functions in the information theory section, so that they are now naturally organized.
Adds docstrings to functions that have none
Adds missing :params: statements for some functions.
In doing this I've found two "bugs" but did not change them to ensure the PR has no side-effects.
nmi is calculated in base e when called with the choice of normalization none (i.e., the MI). There is no way to change the base directly in the function. This could be fixed by adding a logbase argument to nmi which is only used with no normalization.
Likewise vi is also in base e by default with no option to change the behaviour in the function.
Follow-up on issue #28.
This PR does not change any functional part of the code. Instead, it
available_similarity_measures
list in sim.py:params:
statements for some functions.In doing this I've found two "bugs" but did not change them to ensure the PR has no side-effects.
nmi
is calculated in basee
when called with the choice of normalizationnone
(i.e., the MI). There is no way to change the base directly in the function. This could be fixed by adding alogbase
argument tonmi
which is only used with no normalization.vi
is also in basee
by default with no option to change the behaviour in the function.