Update DataLoader Usage Example in Documentation (Fixes #110) #114
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Overview
This pull request addresses the feedback provided in Issue #110 concerning the DataLoader usage example in the repository's documentation. The original example did not properly utilize the
enumerate
function, which is essential for tracking the index of each batch while iterating through the data loader.Changes Made
enumerate()
function. This change ensures that users can correctly obtain both the batch index and the batch contents during iteration.Code Changes
The documentation in the
README.md
file has been updated from:To:
Additional Information
enumerate
enhances the usability of the provided code snippet for developers who may not be familiar with how to manage batch indices effectively.Conclusion
With these updates, the DataLoader example is now more intuitive and functional for users referencing the documentation.
Fixes #110.
Please review the changes and let me know if there are any further modifications required or if any additional documentation needs to be updated!