Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: Add more YAML examples. #313

Open
LeSasse opened this issue Mar 20, 2024 · 3 comments
Open

[DOC]: Add more YAML examples. #313

LeSasse opened this issue Mar 20, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@LeSasse
Copy link
Collaborator

LeSasse commented Mar 20, 2024

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

@LeSasse LeSasse added documentation Improvements or additions to documentation triage New issues waiting to be reviewed labels Mar 20, 2024
@synchon synchon removed the triage New issues waiting to be reviewed label Mar 20, 2024
@synchon
Copy link
Member

synchon commented Mar 20, 2024

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
Copy link
Collaborator Author

LeSasse commented Mar 20, 2024

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
Copy link
Contributor

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.

@synchon synchon added this to the 0.0.5 (alpha 4) milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants