Complexity API #134
Complexity API #134
Conversation
Codecov Report
@@ Coverage Diff @@
## main #134 +/- ##
==========================================
- Coverage 78.27% 78.18% -0.09%
==========================================
Files 30 32 +2
Lines 718 729 +11
==========================================
+ Hits 562 570 +8
- Misses 156 159 +3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
docs/src/complexity_measures.md
Outdated
| @@ -1,8 +1,13 @@ | |||
| # [Complexity measures](@id complexity_measures) | |||
| # [Complexity API](@id complexity_measures) | |||
There was a problem hiding this comment.
| # [Complexity API](@id complexity_measures) | |
| # [Complexity measures API](@id complexity_measures) |
Complexity is the name of a scientific field (the study of complex systems).
src/complexity.jl
Outdated
| """ | ||
| ComplexityMeasure | ||
|
|
||
| Abstract type for (entropy-like) complexity measures. |
There was a problem hiding this comment.
| Abstract type for (entropy-like) complexity measures. | |
| Supertype for (entropy-like) complexity measures. |
(that's how its typically called, see e.g. AbstractDict)
src/complexity.jl
Outdated
| following measures: | ||
|
|
||
| - [`ReverseDispersion`](@ref). | ||
|
|
There was a problem hiding this comment.
Shall we add the standard 'see Input data for how Entropies.jl expects input types' here as well? Like in probabilities.
src/complexity.jl
Outdated
| Estimate the normalized complexity measure `c` for input data `x`, where `c` can | ||
| can be any of the following measures: | ||
|
|
||
| - [`ReverseDispersion`](@ref). | ||
|
|
||
| The potential range `[a, b]` of the output value depends on `c`. See the documentation | ||
| strings for the individual measures to get the normalized ranges. |
There was a problem hiding this comment.
We should avoid duplicate information here. We shouldn't list the available measures. Instead, cross reference complexity docstring.
I also am not sure how much of value is the entire last sentence, and I would remove it.
But, what is even the normalized complexity mesure? In entropy this is clearly defined: the value of the entropy divided by the maximum possible value for the given estimator. Isn't it the same here? If so, maybe just say this?
There was a problem hiding this comment.
We should avoid duplicate information here. We shouldn't list the available measures. Instead, cross reference complexity docstring.
That makes sense.
But, what is even the normalized complexity mesure? In entropy this is clearly defined: the value of the entropy divided by the maximum possible value for the given estimator. Isn't it the same here? If so, maybe just say this?
Given that there are many different concepts that fall under the umbrella "complexity measure", there's no way - like for entropy - to know how one would like to normalize it. It would be method-specific.
There was a problem hiding this comment.
See my latest commit for a suggestion on an improve docstrings.
@Datseris I've addressed your comments in the latest commit. Feel free to merge if you're happy with it. |
New complexity API, as agreed on in #133.
As soon as this is merged, I'll bring the non-merged complexity measure PRs up to speed, and they will then also be ready for review.