eFEL icon indicating copy to clipboard operation
eFEL copied to clipboard

Feature documentation?

Open Helveg opened this issue 4 years ago • 4 comments

It's been a while that the eFeature documentation here seems incomplete. Are there any plans of completing this guide? Currently I'm stuck trying to look through all of efel.getFeatureNames() to scout for interesting hits based on their name ;p Combine that with https://github.com/BlueBrain/eFEL/issues/27 lacking official docs or code snippets and it's not so clear how exactly to use efel from Python when the feature isn't readily available and explained in the first link.

Helveg avatar Mar 01 '21 18:03 Helveg

Hello @Helveg, for the eFeature descriptions, all of the features should be documented in the pdf linked at the top of the page https://efel.readthedocs.io/en/latest/eFeatures.html. Did you notice any missing ? For code snippets, it is true that the examples in the present repository are lacking, we could add new ones.

DrTaDa avatar Mar 02 '21 08:03 DrTaDa

Oh ok, there's an extra PDF? I'll look at that shortly but it would be nicer to have that in the sphinx doc ofcourse which is easier to search, navigate and index on search engines.

Helveg avatar Mar 02 '21 08:03 Helveg

Yes, I know it's annoying to have a mix of documentation locations. As I mentioned in the other ticket, we're planning a big restructuring of the code. We will definitely make sure everything is correctly documented in one place there. One of the reasons the pdf is still there is because there are quite some features that are never used. We also don't need to document all these never-used features. If you let us know some important features you need, we can already now put them in the sphinx docs.

wvangeit avatar Mar 04 '21 14:03 wvangeit

Well some of the features seem to only exist for the first five spikes, is there a general n-th or all spike variant for them? Also, is frequency available as a feature?

Helveg avatar Mar 04 '21 16:03 Helveg