funkelab / gunpowder

A library to facilitate machine learning on multi-dimensional images.
https://funkelab.github.io/gunpowder/
MIT License
79 stars 56 forks source link

Add hidden nodes to the API reference #106

Closed bentaculum closed 4 years ago

bentaculum commented 4 years ago

There are some nodes with nice docstrings, but do not show up in the API reference. I added them to the proper subsections. There are two more nodes I did not add:

pattonw commented 4 years ago

Nice! Not sure about the N5Write docs though. The n5 specific nodes have been removed in v1.2-dev branch (they are redundant since the Zarr nodes can handle n5. This also allows us to drop the z5py dependency). Also I'm not sure how to see the docs for other gunpowder versions other than 1.1, so maybe we want to include these in the next patch (patch-1.1.6) for master. Could you switch the pull request target? I would say the DaisyRequestBlocks docs should go in the Training/Prediction group since I think it is mostly used for large scale prediction. Or make a new section since it doesn't neatly fit into any of the current groups.

bentaculum commented 4 years ago

Made a new PR #107 with your suggestions.