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

Documenting config files and source code #6

Open
suksia opened this issue Nov 1, 2024 · 0 comments
Open

Documenting config files and source code #6

suksia opened this issue Nov 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@suksia
Copy link
Collaborator

suksia commented Nov 1, 2024

README files should be made for the configs directory and for each script in the src directory.

For the configs directory, each training loop (Single, CrossVal, Inference) should have all possible kwargs listed and what they mean/how they should be specified.

For the src directory, an in-depth discussion of the purpose of each script should be made so that the package can be easily understood.

@suksia suksia added the documentation Improvements or additions to documentation label Nov 1, 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

1 participant