JuliaDynamics / ComplexityMeasures.jl

Estimators for probabilities, entropies, and other complexity measures derived from data in the context of nonlinear dynamics and complex systems
MIT License
55 stars 13 forks source link

Remove encodings / outcome of PR#162 #169

Closed Datseris closed 1 year ago

Datseris commented 1 year ago

PR#162 introduced outcome_space and had a lengthy discussion of what "outcomes" should be. In conclusion, outcome should be hashable, but as detailed as possible. So, NOT integers.

Currently we encodings as part of the public API. These are not ready yet and we have not concluded on what the encoding API should be. Hence, Encodings must be removed from all docs. Encoding code can stay internally but shouldn't be relied on too much until the devs have agreed on an API and this has been designed and implemented fully.

In conclusion this leads some outstanding todos after #162 :

Datseris commented 1 year ago

First half of TODOs was done in https://github.com/JuliaDynamics/Entropies.jl/pull/170

kahaaga commented 1 year ago

The symbolic-related TODOs were done in #172.

kahaaga commented 1 year ago

Finished by #178.