search

juaml / junifer

Forschungszentrum Jülich Neuroimaging Feature Extractor
https://juaml.github.io/junifer
GNU Affero General Public License v3.0
14 stars 13 forks source link

[DOC]: Add more YAML examples. #313

Open LeSasse opened 8 months ago

LeSasse commented 8 months ago

Which element of the documentation do you want to modify and why?

The YAML example section is quite sparse at the moment, so I was thinking I could at least add example yaml's how to process the AOMIC datasets (which are good examples since they are serious datasets that require no credentials at all).

In addition, I think the YAML examples are not really discoverable from the documentation web page as far as I can tell, but I think this could help, perhaps? What do you think?

Anything else to say?

No response

synchon commented 8 months ago

If you would like to contribute, that would help a lot. There's a plan to restructure the examples to only have YAML (which is the primary way to interact with junifer) and maybe have an advanced section to have the Python usage as well.

LeSasse commented 8 months ago

If you would like to contribute, that would help a lot. There's a plan to restructure the examples to only have YAML (which is the primary way to interact with junifer) and maybe have an advanced section to have the Python usage as well.

I think thats along the right lines. The only time users should really have to use python is for custom objects, but not for running the pipeline. Would be happy to help.

fraimondo commented 8 months ago

One thing that I did with julearn that it was going to be part of junifer is to actually run the examples to make sure that they actually work.

The main reason is that if there's a change in junifer that breaks an example, we want to detect it.

Maybe we can have another "test suite" that tests the examples.