...
Feature Shepherd
A Shepherd is a Apache MXNet committer who has reviewed the design, provided feedback on the design and works with you to take your feature to completion by providing timely feedback on your PRs and helps in merging to the Apache MXNet codebase. You can add the GitHub id of the committer in this section once the design has been agreed upon by the community on dev@ and a shepherd has volunteered or chosen.
Problem
Describe the problem your design proposal aims to solve. For an example see the link below
...
MXNet Java Inference API#SequenceDiagram
Addition of New APIs
Is your design introducing any new public Interfaces or public classes. This should map to the use-cases above.
Backward compatibility
Are you changing any Interfaces(APIs), adding new mandatory parameters.
Are you changing the input/output data format?
Performance Considerations
Apache MXNet is known and admired for its performance and we want to maintain that. Are there are any performance impact(positive or negative) based on your design.
You should describe what tests are necessary or planned to make sure there are no performance regressions.
Test Plan
How do you plan to test your new features. Please describe what Unit Tests and Integration Tests will added/modified for this implementation.
Alternative Approaches
Alternate design approaches considered,
...
MXNet Scala API Usability Improvement#AlternativeApproachconsidered
Backward compatibility
Is your design introducing any new public Interfaces or public classes.
Are you changing any Interfaces(APIs), adding new mandatory parameters.
Are you changing the input/output data format?
Technical Challenges
Are there any technical challenges in implementing your solution. For an example see the link below
...