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

Update docs for fill_last_batch parameter to match the real behavior #1479

Merged
merged 8 commits into from
Nov 19, 2019
Merged

Update docs for fill_last_batch parameter to match the real behavior #1479

merged 8 commits into from
Nov 19, 2019

Conversation

bonlime
Copy link
Contributor

@bonlime bonlime commented Nov 19, 2019

Why we need this PR?

  • It fixes a bug
  • It adds new feature needed because why we need this feature
  • Refactoring to improve what

What happened in this PR?

Fixed fill_last_batch parameter docstring to match the real behavior

fixed `fill_last_batch` doc to match the real behavior
fixed `fill_last_batch` doc to match the real behavior
fixed `fill_last_batch` doc to match the real behavior
Copy link
Contributor

@JanuszL JanuszL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is still not fully accurate. There is also a last_batch_padded in the iterator and pad_last_batch from the reader which combined together impacts the overall behaviour. You can check the table with an example at the end of the function docstring you have updated.

@bonlime
Copy link
Contributor Author

bonlime commented Nov 19, 2019

would changing

Whether to fill the last batch with data from next epoch

to

Whether to fill the last batch with data up to 'self.batch_size'

make it more accurate? I do understand that a combination of these 3 parameters may produce unexpected behavior but I think that it's enough to say what one parameter changes and everything else is explained in the table at the end of the docstring

@JanuszL
Copy link
Contributor

JanuszL commented Nov 19, 2019

would changing

Whether to fill the last batch with data from next epoch

to

Whether to fill the last batch with data up to 'self.batch_size'

make it more accurate? I do understand that a combination of these 3 parameters may produce unexpected behavior but I think that it's enough to say what one parameter changes and everything else is explained in the table at the end of the docstring

I agree with the new wording. Please adjust accordingly.

@JanuszL
Copy link
Contributor

JanuszL commented Nov 19, 2019

@bonlime - can you add a sign-off to your commit so we can merge it?

Signed-off-by: Emil Zakirov <bonlimezak@gmail.com>
…o bonlime-patch-1

Signed-off-by: Emil Zakirov <bonlimezak@gmail.com>
Signed-off-by: Emil Zakirov <bonlimezak@gmail.com>
@bonlime
Copy link
Contributor Author

bonlime commented Nov 19, 2019

Okay. I have to admit I don't know how to sign previous commits :c

@JanuszL JanuszL merged commit 5db1e35 into NVIDIA:master Nov 19, 2019
@JanuszL
Copy link
Contributor

JanuszL commented Nov 19, 2019

That is enough. Thanks for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants