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

Document data methods #50

Merged
merged 1 commit into from
Oct 31, 2023
Merged

Document data methods #50

merged 1 commit into from
Oct 31, 2023

Conversation

ziw-liu
Copy link
Collaborator

@ziw-liu ziw-liu commented Sep 6, 2023

Added docstrings for non-lightning datamodule methods and private functions.

For the complete batch-loading process, see how hooks are called in pytorch lightning. It is helpful for developers to familiarize themselves with the framework used, rather than trying to recreate the documentation.

Resolves #48.

@ziw-liu ziw-liu marked this pull request as ready for review September 27, 2023 16:57
@ziw-liu ziw-liu added the documentation Improvements or additions to documentation label Sep 27, 2023
@mattersoflight mattersoflight requested review from mattersoflight and removed request for edyoshikun and Soorya19Pradeep October 31, 2023 19:52
@mattersoflight mattersoflight merged commit f889ff1 into main Oct 31, 2023
3 checks passed
@ziw-liu ziw-liu deleted the document-datamodule branch November 1, 2023 04:46
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

Successfully merging this pull request may close these issues.

documentation of data.py
2 participants