Skip to content

Commit

Permalink
Documentation fixes (#212)
Browse files Browse the repository at this point in the history
* Introduce a separate menu element to make distinction clearer

* Remove reference to non-implemented method
  • Loading branch information
kahaaga authored Dec 21, 2022
1 parent f441b44 commit 3de9294
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions docs/src/entropies.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ Curado
StretchedExponential
```

## Estimation

### Discrete entropies
## Estimation (discrete)

Discrete entropies are just simple functions (sums, actually) of
probability mass functions [(pmf)](https://en.wikipedia.org/wiki/Probability_mass_function),
Expand All @@ -36,7 +34,6 @@ Tables scroll sideways, so are best viewed on a large screen.
| [`ValueHistogram`](@ref) | Binning (histogram) | `Vector`, `Dataset` |||||||
| [`TransferOperator`](@ref) | Binning (transfer operator) | `Vector`, `Dataset` |||||||
| [`NaiveKernel`](@ref) | Kernel density estimation | `Dataset` |||||||
| [`LocalLikelihood`](@ref) | Local likelihood Estimation | `Dataset` |||||||
| [`SymbolicPermutation`](@ref) | Ordinal patterns | `Vector` |||||||
| [`SymbolicWeightedPermutation`](@ref) | Ordinal patterns | `Vector` |||||||
| [`SymbolicAmplitudeAwarePermutation`](@ref) | Ordinal patterns | `Vector` |||||||
Expand All @@ -45,7 +42,7 @@ Tables scroll sideways, so are best viewed on a large screen.
| [`WaveletOverlap`](@ref) | Wavelet transform | `Vector` |||||||
| [`PowerSpectrum`](@ref) | Fourier spectra | `Vector`, `Dataset` |||||||

### Continuous/differential entropies
### Estimation (continuous/differential)

The following estimators are *differential* entropy estimators, and can also be used
with [`entropy`](@ref). Differential) entropies are functions of *integrals*, and usually
Expand Down

0 comments on commit 3de9294

Please sign in to comment.