This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Update documentation for MXNetDataIter in io.py (#6000) #6113
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
Update documentation for MXNetDataIter in io.py (#6000)
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -577,8 +577,16 @@ class MXDataIter(DataIter): | |
|
||
Parameters | ||
---------- | ||
handle : DataIterHandle | ||
handle : DataIterHandle, required | ||
The handle to the underlying C++ Data Iterator. | ||
data_name : str, optional | ||
Data name. Default to "data". | ||
label_name : str, optional | ||
Label name. Default to "softmax_label". | ||
|
||
See Also | ||
-------- | ||
c_api.cc : The underlying C++ data iterator implementation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the iterators are under src/io |
||
""" | ||
def __init__(self, handle, data_name='data', label_name='softmax_label', **_): | ||
super(MXDataIter, self).__init__() | ||
|
@@ -597,7 +605,6 @@ def __init__(self, handle, data_name='data', label_name='softmax_label', **_): | |
self.provide_label = [DataDesc(label_name, label.shape, label.dtype)] | ||
self.batch_size = data.shape[0] | ||
|
||
|
||
def __del__(self): | ||
check_call(_LIB.MXDataIterFree(self.handle)) | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
elaborate. this outputs one data blob and one label blob, etc, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"this outputs one data blob and one label blob" seems to already get taken care of in the
DataIter
documentation. I guess no need to repeat it in theMXDataIter
doc. Let me know if there are other things I should explain. Thanks!!