Add NEWS and README #11267

anirudh2290 · 2018-06-14T00:09:44Z

Description

Added NEWs and README.

@ThomasDelteil @piiswrong @zheng-da @eric-haibin-lin @nswamy @lebeg @lanking520 @andrewfayres

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
Changes are complete (i.e. I finished coding on this PR)
All changes have test coverage:
Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
Code is well-documented:
For user-facing API changes, API doc string has been updated.
For new C++ functions in header files, their functionalities and arguments are documented.
For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

Feature1, tests, (and when applicable, API doc)
Feature2, tests, (and when applicable, API doc)

Comments

If this change is a backward incompatible change, why must this change be made.
Interesting edge cases to note here

ThomasDelteil

minor wording change, given state of CI, feel free to ignore if build passes

ThomasDelteil · 2018-06-14T00:58:59Z

NEWS.md

@@ -1,5 +1,19 @@
 MXNet Change Log
 ================
+## 1.2.1
+### Deprecations
+- An incorrect [usage](https://github.com/apache/incubator-mxnet/issues/11091) of `save_params` was advertised in the gluon book which led to MXNet users depending on the incorrect usage and developing a hack around it. A change to internal structure of params file saved by `save_params` to resolve a bug, led to user scripts with the above mentioned hack to break. To fix this, we have reverted `save_params` and `load_params` to previous format and marked it as deprecated. We have added new APIs `save_parameters` and `load_parameters` for the new format. All scripts to save and load parameters for a Gluon model should now use the new API for `save_parameters` and `load_parameters`. If your model is hybridizable and you want to export a serialized structure of the model as well as parameters you need to use the `export` API and the newly added `imports` API instead of `save_params` and `load_params` API. For more details, Please see: [issue](https://github.com/apache/incubator-mxnet/issues/11091), [PR](https://github.com/apache/incubator-mxnet/pull/11127).


-> A change was made to the internal structure of the .params file saved by save_params to resolve a bug. This led to user scripts with the above mentioned hack to break

anirudh2290 · 2018-06-14T18:15:48Z

@ThomasDelteil Thanks! I have fixed it.

eric-haibin-lin · 2018-06-14T21:35:45Z

NEWS.md

+- Reduced memory consumption from inplace operation for ReLU activation (#10847).
+- Improved `slice` operator performance by 20x (#11124).
+- Improved performance of depthwise convolution by using cudnnv7 if available (#11076).
+- Improved performance and memory usage of Conv1D, by adding back cuDNN support for Conv1D (#11270). This adds a known issue: The cuDNN convolution operator may throw `CUDNN_STATUS_EXECUTION_FAILED` when `req == "add"` and `cudnn_tune != off` with large inputs(e.g. 64k channels). If you encounter this issue, please consider setting `cudnn_tune = "off"`.


Since cudnn_tune requires changing users' python script, let's change to

If you encounter this issue, please consider setting environment variable MXNET_CUDNN_AUTOTUNE_DEFAULT to 0.

anirudh2290 · 2018-06-14T22:33:06Z

@piiswrong @ThomasDelteil cherry picked your changes. Please help review as i had to resolve some conflicts. This PR needs to be merged without squashing.

piiswrong · 2018-06-14T22:37:38Z

I think 7632100 is too verbose. It would only confuse users. A simple pointer to export/import should be enough

ThomasDelteil

please update the reference to the hybridize flags

ThomasDelteil · 2018-06-14T22:38:50Z

docs/tutorials/gluon/hybrid.md

+```python
+net.hybridize(static_alloc=True)
+# or
+net.hybridize(static_alloc=True, static_shape=True)


This is slower in 1.2 #11293
let's not advertise it. I don't even think these flags exist in 1.2.0
let's just mention net.hybridize() in 1.2

ThomasDelteil · 2018-06-14T22:50:30Z

@piiswrong I think we can remove this sentence:

Such model can then be loaded back in any language binding
or even in Gluon using a :py:class:`SymbolBlock`.

The rest I think is necessary to disambiguate the current API.

…rs() (apache#11210)

anirudh2290 · 2018-06-14T23:47:12Z

I agree that we need the rest of the content to inform users about the save_parameters being the new API to use instead of save_params and to use export to serialize the model.

* enable cudnn for conv1d * add checks for backward * fix build * fix build * fix lint * Update convolution.cc

* Fixed armv7 wheel * Fixed bash default value substitution * Fixed whitespace errors * Added unzip installation to crosscompile docker images * Removed deprecated apt lists removal * Moved common parts to scripts for docker builds * Disabled bundled OpenMP for cross compilation * Added make based build for armv7 as option * Renamed install_openblas.sh -> arm_openblas.sh * Removed makefile build for armv7 * Trigger CI * Link OpenBLAS statically for cross compilations

* Fixes Scala memory leak (apache#10436) * Replaced the copy and disposed of sliced ndArray to resolve memory leak * Wrapped disposes in a finally to ensure they are called.

anirudh2290 · 2018-06-15T00:37:56Z

Closing this PR and will a new PR since I have messed up my git history.

ThomasDelteil approved these changes Jun 14, 2018

View reviewed changes

anirudh2290 changed the title ~~[WIP] Add NEWS and README~~ Add NEWS and README Jun 14, 2018

anirudh2290 force-pushed the ADD_NEWS_README branch from ae48d71 to 2af551a Compare June 14, 2018 21:08

eric-haibin-lin reviewed Jun 14, 2018

View reviewed changes

Add NEWS and README

d9666c7

anirudh2290 force-pushed the ADD_NEWS_README branch from 2af551a to d9666c7 Compare June 14, 2018 21:42

add import_ for SymbolBlock (apache#11127)

44a1734

anirudh2290 requested a review from szha as a code owner June 14, 2018 22:29

ThomasDelteil suggested changes Jun 14, 2018

View reviewed changes

Improve hybridblock doc (apache#11236)

45f9a58

[MXNET-532] Clarify documentation of save_parameters(), load_paramete…

4fa22ae

…rs() (apache#11210)

anirudh2290 force-pushed the ADD_NEWS_README branch from 7632100 to 4fa22ae Compare June 14, 2018 22:51

marcoabreu force-pushed the v1.2.0 branch from 64daa91 to a48480b Compare June 14, 2018 23:05

eric-haibin-lin and others added 4 commits June 15, 2018 00:04

Enable CUDNN for conv1D (apache#11194) (apache#11270)

cf08870

* enable cudnn for conv1d * add checks for backward * fix build * fix build * fix lint * Update convolution.cc

Scala inference memory leak fix apache#11204 (apache#11216)

70105f4

* Fixes Scala memory leak (apache#10436) * Replaced the copy and disposed of sliced ndArray to resolve memory leak * Wrapped disposes in a finally to ensure they are called.

Remove extra line

b34d518

anirudh2290 force-pushed the ADD_NEWS_README branch from c00e673 to b34d518 Compare June 15, 2018 00:07

anirudh2290 requested a review from yzhliu as a code owner June 15, 2018 00:07

anirudh2290 closed this Jun 15, 2018

anirudh2290 mentioned this pull request Jun 15, 2018

Add NEWS and README #11298

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add NEWS and README #11267

Add NEWS and README #11267

anirudh2290 commented Jun 14, 2018

ThomasDelteil left a comment

ThomasDelteil Jun 14, 2018

anirudh2290 commented Jun 14, 2018

eric-haibin-lin Jun 14, 2018

anirudh2290 commented Jun 14, 2018 •

edited

Loading

piiswrong commented Jun 14, 2018

ThomasDelteil left a comment

ThomasDelteil Jun 14, 2018

anirudh2290 Jun 14, 2018

ThomasDelteil commented Jun 14, 2018

anirudh2290 commented Jun 14, 2018

anirudh2290 commented Jun 15, 2018

Add NEWS and README #11267

Add NEWS and README #11267

Conversation

anirudh2290 commented Jun 14, 2018

Description

Checklist

Essentials

Changes

Comments

ThomasDelteil left a comment

Choose a reason for hiding this comment

ThomasDelteil Jun 14, 2018

Choose a reason for hiding this comment

anirudh2290 commented Jun 14, 2018

eric-haibin-lin Jun 14, 2018

Choose a reason for hiding this comment

anirudh2290 commented Jun 14, 2018 • edited Loading

piiswrong commented Jun 14, 2018

ThomasDelteil left a comment

Choose a reason for hiding this comment

ThomasDelteil Jun 14, 2018

Choose a reason for hiding this comment

anirudh2290 Jun 14, 2018

Choose a reason for hiding this comment

ThomasDelteil commented Jun 14, 2018

anirudh2290 commented Jun 14, 2018

anirudh2290 commented Jun 15, 2018

anirudh2290 commented Jun 14, 2018 •

edited

Loading