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

[ENH] Enhance documentation #171

Open
Tritbool opened this issue Feb 13, 2024 · 0 comments
Open

[ENH] Enhance documentation #171

Tritbool opened this issue Feb 13, 2024 · 0 comments
Labels
🧍 aspect: accessibility Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository 🏁 status: ready for dev Ready for work

Comments

@Tritbool
Copy link

Goal

Enhance documentation

Why this is useful

VOCABULARY

To help non-expert reproduce the experiment, the vocabulary should be more explicit. in particular we should describe better runs, gain and loss (as values for the subject), and other data that can be misleading because polysemous.

DATA

  1. Data cannot be retrieved using the command cd data; datalad get ./* it misses the --recursive option.
  2. It should be mentioned that the dataset is near 1TB big.
  3. It should be noted that the subjects' data used for the pipelines is determined by a list. Thus, getting only the few first of that list could be sufficient for pipeline implementation and some non-exhaustive testing.

Timeline

N/A

More specifically

No response

Open questions

REPRODUCIBILITY

Maybe we should consider warning users on the RAM needs for the 'worst case' pipeline ?

@Tritbool Tritbool added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Feb 13, 2024
@bclenet bclenet changed the title [ENH] [ENH] Enhance documentation Feb 14, 2024
@bclenet bclenet added 🏁 status: ready for dev Ready for work 📄 aspect: text Concerns the textual material in the repository 🧍 aspect: accessibility Concerns developers' experience with the codebase and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧍 aspect: accessibility Concerns developers' experience with the codebase 📄 aspect: text Concerns the textual material in the repository 🏁 status: ready for dev Ready for work
Projects
None yet
Development

No branches or pull requests

2 participants