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

[ONNX] Deprecate various args #65962

Merged
merged 6 commits into from Oct 8, 2021

Commits on Sep 30, 2021

  1. [ONNX] Remove argument _retain_param_name from torch.onnx.export() fu…

    …nction. (pytorch#61702) (pytorch#64370)
    
    Summary:
    Pull Request resolved: pytorch#64370
    
    As of now, the "_retain_param_name" parameter has no description in PyTorch docs website. According to code, this argument determines if we keep the original parameter names of PyTorch model in the final ONNX graph. If this is False, those original parameter names will be replaced with a series of integers starting from 1.
    
    Since setting numbers as parameter names make no sense to users, we remove this argument from the torch.onnx.export() function to increase user experience of calling this function.
    
    This PR will still keep it in torch.onnx.export() function for backward support while all backend logic has been changed to work as _retain_param_name is set to True.
    
    Test Plan: Imported from OSS
    
    Reviewed By: ezyang
    
    Differential Revision: D30905270
    
    Pulled By: malfet
    
    fbshipit-source-id: ca60757ca17daaff937e9f08da42596086795f4a
    
    Co-authored-by: fatcat-z <zhang-ji@outlook.com>
    2 people authored and garymm committed Sep 30, 2021
    Configuration menu
    Copy the full SHA
    c2237de View commit details
    Browse the repository at this point in the history
  2. [ONNX] Remove strip_doc_string param from torch.onnx.export() functio…

    …n. (pytorch#61712) (pytorch#64371)
    
    Summary:
    Pull Request resolved: pytorch#64371
    
    As of now, the "strip_doc_string" parameter was described as below:
    
    strip_doc_string (bool, default True): do not include the field
    doc_string``` from the exported model. Otherwise the field will mention the source code locations for model``.
    
    This is usually useless to users who want to transform a PyTorch model to ONNX one. Only when the user wants to debug the export process, these source code locations could provide benefits.
    
    To make the export() function more friendly by providing less parameters, we combined "strip_doc_string" into "verbose" parameter. If a user set verbose to True, it means the users need some log information for debugging the export process and this is similar with the purpose of strip_doc_string parameter.
    
    But the usage of these 2 arguments are opposite: setting verbose to True means we want to print log information to help debug, which means strip_doc_string should be False. And this is how we replace strip_doc_string with verbose argument in this PR.
    
    This PR will still keep it in torch.onnx.export() function for backward support while the usage of it has been combined with verbose argument.
    
    Test Plan: Imported from OSS
    
    Reviewed By: ezyang
    
    Differential Revision: D30905268
    
    Pulled By: malfet
    
    fbshipit-source-id: 2f06eb805c01fe15ff7a1b4f6595c937ba716d60
    
    Co-authored-by: fatcat-z <zhang-ji@outlook.com>
    2 people authored and garymm committed Sep 30, 2021
    Configuration menu
    Copy the full SHA
    b7274b1 View commit details
    Browse the repository at this point in the history
  3. [ONNX] minor doc improvements and cleanup (pytorch#62514) (pytorch#64373

    )
    
    Summary:
    Pull Request resolved: pytorch#64373
    
    * Fix some bad formatting and clarify things in onnx.rst.
    * In `export_to_pretty_string`:
        * Add documentation for previously undocumented args.
        * Document that `f` arg is ignored and mark it deprecated.
        * Update tests to stop setting `f`.
        * Warn if `_retain_param_name` is set.
    * Use double quotes for string literals in test_operators.py.
    
    Test Plan: Imported from OSS
    
    Reviewed By: ezyang
    
    Differential Revision: D30905271
    
    Pulled By: malfet
    
    fbshipit-source-id: 3627eeabf40b9516c4a83cfab424ce537b36e4b3
    BowenBao authored and garymm committed Sep 30, 2021
    Configuration menu
    Copy the full SHA
    362e5cd View commit details
    Browse the repository at this point in the history
  4. [ONNX] Deprecated the example_outputs param from torch.onnx.export() …

    …function. (pytorch#62815) (pytorch#64380)
    
    Summary:
    Pull Request resolved: pytorch#64380
    
    * `example_outputs` used to determine the type and shape of the outputs without tracing the execution of the model. And it must be provided when exporting a ScriptModule or ScriptFunction when using export() function.
    
    * Since we can work out `example_outputs` in internal function instead of being provided by user, so we deprecated this argument in the export() function to increase user experience of calling this function.
    
    Test Plan: Imported from OSS
    
    Reviewed By: ezyang
    
    Differential Revision: D30905266
    
    Pulled By: malfet
    
    fbshipit-source-id: d00b00d7d02b365d165028288ad915678caa51f2
    
    Co-authored-by: hwangdeyu <dejack953@outlook.com>
    2 people authored and garymm committed Sep 30, 2021
    Configuration menu
    Copy the full SHA
    9f12106 View commit details
    Browse the repository at this point in the history
  5. [ONNX] Deprecate use_external_data_format param from torch.onnx.expor…

    …t() function. (pytorch#62257) (pytorch#64382)
    
    Summary:
    Pull Request resolved: pytorch#64382
    
    * This `use_external_data_format` parameter is used for large models cannot be exported because of the 2GB protobuf limit.
    
    * When `use_external_data_format` set to True, the model is exported in ONNX external data format, in which case some of the model parameters are stored in external binary files and not in the ONNX model file itself.
    
    * This PR will set this paramter to DEPRECATED and check the model proto sizes by code instead of by user, if the sizes lager than 2GB, then `use_external_data_format = True` automatically.
    
    Test Plan: Imported from OSS
    
    Reviewed By: ezyang
    
    Differential Revision: D30905265
    
    Pulled By: malfet
    
    fbshipit-source-id: 82b4e17bfa6a8de2bfd700a5282c12f6835603cb
    
    Co-authored-by: hwangdeyu <dejack953@outlook.com>
    2 people authored and garymm committed Sep 30, 2021
    Configuration menu
    Copy the full SHA
    9c2fa89 View commit details
    Browse the repository at this point in the history

Commits on Oct 6, 2021

  1. fix clang-tidy error introduced by pytorch#64382 (pytorch#65977)

    Summary: Pull Request resolved: pytorch#65977
    
    Reviewed By: ngimel
    
    Differential Revision: D31423174
    
    Pulled By: malfet
    
    fbshipit-source-id: 0ea560b9a6ddd6431f70bd3ac10ace68e26ab352
    garymm committed Oct 6, 2021
    Configuration menu
    Copy the full SHA
    41ca83c View commit details
    Browse the repository at this point in the history