This is an initial DRAFT – still needs to be discussed
Apache MXNet PR Best Practices
For contributors,
Describing your patch with enough details will help reviewers to provide you with quick feedback and there by the patch getting into the Apache MXNet repository.
If this is a new Feature, reviewers will expect you to have discussed this on dev@ and for large features have a corresponding design proposal on cwiki under Design Proposals.
The proposal is expected to be reviewed by at least by 2 committers of the Apache MXNet project or have passed 72 hours( Saturday+Sunday together considered 24 hours) after the proposal and a lazy consensus is assumed.
Design challenges/approaches are still a fair game during code reviews.
Here are a few guidelines with an example on how to structure your PR.
Describe in detail what this patch is about:
[MXNet-Scala] Adding new Parameters (dataDescriptor, labelDescriptor) to DataBatch, DataIter constructors.
Consider providing an overview here
Why is this patch required?
This change is necessary to support different data and label layouts. For example: RNN based networks require different layouts(“TNC”/”NTC”). Current implementation of DataBatch, DataIter does not support different layouts and assumes a fixed layout based on the shape of the NDArray returned in the next() call to the iterator.
How have you tested this patch?
Unit Tests — Added new Unit Tests for the new constructors/Updated DataBatch Tests. — Current Unit Tests pass.
Integration Tests - pass
If it is a change to the API, does this maintain backward compatibility?
If No — describe why ?
Additionally,
If you added new/modified APIs, please add a few Examples to demonstrate the usage of the API
...