Update batch_viewer docs to accurately reflect data indexing #176
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.
A change to address the issue below.
Issue: Documentation for Step Viewing
Currently, the documentation for
utils/batch_viewer.py
reads as follows:In normal Python ranges (e.g.
range(a,b)
, the first number is inclusive, so this would imply to me that a start of 1 and an end of 5 should include data from steps 1, 2, 3, 4, and 5.However, a small experiment reveals this is not the case, as one cannot get a full batch of data by giving a start/end that are one apart (you would expect there to be two batches of data here in an inclusive/inclusive world):
Similarly, when using the same number for start and end, you get a np array of shape (1, 2049).
This implies either the beginning is exclusive, or the ending is not inclusive as documented. I put in a PR with the former, but please let me know / change it if it's the latter!