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

[Documentation] Outdated doc for using xnnpackage #19662

Closed
csukuangfj opened this issue Feb 27, 2024 · 7 comments
Closed

[Documentation] Outdated doc for using xnnpackage #19662

csukuangfj opened this issue Feb 27, 2024 · 7 comments
Labels
documentation improvements or additions to documentation; typically submitted using template

Comments

@csukuangfj
Copy link
Contributor

Describe the documentation issue

The following link says

Ort::Env env = Ort::Env{ORT_LOGGING_LEVEL_ERROR, "Default"};
Ort::SessionOptions so;
so.AppendExecutionProvider("XNNPACK", intra_op_num_threads);
Ort::Session session(env, model_path, so);

However,

so.AppendExecutionProvider("XNNPACK", intra_op_num_threads);

is not valid anymore.

The latest code is

/// Wraps OrtApi::SessionOptionsAppendExecutionProvider. Currently supports QNN, SNPE and XNNPACK.
SessionOptionsImpl& AppendExecutionProvider(const std::string& provider_name,
const std::unordered_map<std::string, std::string>& provider_options = {});

The second argument is of type const std::unordered_map<std::string, std::string>& , not an integer.

Page / URL

https://onnxruntime.ai/docs/execution-providers/Xnnpack-ExecutionProvider.html#usage

@csukuangfj csukuangfj added the documentation improvements or additions to documentation; typically submitted using template label Feb 27, 2024
@wejoncy
Copy link
Contributor

wejoncy commented Feb 27, 2024

Thanks for your catching.

Could you please issue a PR for this?

@csukuangfj
Copy link
Contributor Author

I find that
https://github.com/microsoft/onnxruntime/blob/gh-pages/docs/execution-providers/Xnnpack-ExecutionProvider.md
has already updated it.

However, the page at https://onnxruntime.ai/docs/execution-providers/Xnnpack-ExecutionProvider.html
does not show the latest change from gh-pages.

@wejoncy
Copy link
Contributor

wejoncy commented Feb 27, 2024

Hi @natke Could you please have a look at it?

@natke
Copy link
Contributor

natke commented Feb 28, 2024

Fixed the rendering of the snippet, if you could review @wejoncy #19685

@natke
Copy link
Contributor

natke commented Feb 28, 2024

Fixed by #19685

@wejoncy
Copy link
Contributor

wejoncy commented Feb 28, 2024

Fixed the rendering of the snippet, if you could review @wejoncy #19685

Thanks

@wejoncy
Copy link
Contributor

wejoncy commented Feb 28, 2024

Closed as issue has been fixed.

@wejoncy wejoncy closed this as completed Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation improvements or additions to documentation; typically submitted using template
Projects
None yet
Development

No branches or pull requests

3 participants