essentia icon indicating copy to clipboard operation
essentia copied to clipboard

Improve documentation for templated/special algorithms and connectors

Open dbogdanov opened this issue 6 years ago • 1 comments

Add documentation for templated/"special" algorithms and connectors (such as VectorInput, DiskWriter, RingBufferInput, etc.).

This may go to the algorithm reference, or a special page linked from the reference, so that they are easier to find. Right now, their description is scattered across a few places (VectorInput, special connectors).

Add example code of their use to the descriptions (for example, VectorInput contains a doc page in the reference, and it will be useful to have an example of its declaration and use on the same page).

dbogdanov avatar Jan 30 '19 16:01 dbogdanov

@dbogdanov thanks for the special connectors doc, it's helpful. For streaming mode, is running algorithm.process() alone enough or it still requires network.run()? if that's the case, what needs to be passed into network when it's initialized, i.e. Network network(VectorInput)?

yyf avatar Feb 17 '22 01:02 yyf