[GitHub] ThomasDelteil commented on a change in pull request #11478: 1.2.1 release notes

[GitBox <gi...@apache.org>]

ThomasDelteil commented on a change in pull request #11478: 1.2.1 release notes
URL: https://github.com/apache/incubator-mxnet/pull/11478#discussion_r199023190
 
 

 ##########
 File path: NEWS.md
 ##########
 @@ -4,6 +4,15 @@ MXNet Change Log
 ### 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 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. To fix this, `save_params` and `load_params` APIs have been reverted to previous format and marked as deprecated. New APIs: `save_parameters` and `load_parameters` have been added 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).
 
+### User Code Changes
+- If you have been using the `save_params` and `load_params` API, below are the recommendations on how to update your code:
+1. If you save parameters to load it back into a `SymbolBlock`, it is strongly recommended to use `export` and `imports` API instead. Although, this is not an use-case that the API was meant to support, it won't break your user code. For more information, please see the docs [here](https://mxnet.incubator.apache.org/tutorials/gluon/save_load_params.html).
 
 Review comment:
   "Although, this is not an use-case that the API was meant to support, it won't break your user code" => I think this confuses more than inform, people that are using it already know it works for them, and shouldn't expect it to break, but ideally we would like to encourage to move to export/imports

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services