Skip to content

ETDump doc improvements #16571

@GregoryComer

Description

@GregoryComer

📚 The doc issue

While enabling etdump for a custom binary following the docs (https://docs.pytorch.org/executorch/stable/etdump.html), there are a few pain points I ran into that we could potentially alleviate:

  • What CMake target(s) need to be linked for etdump support?
    • Looks like it should be the etdump target.
  • What CMake options should be set for the runtime build?
    • Looks like EXECUTORCH_BUILD_DEVTOOLS and EXECUTORCH_ENABLE_EVENT_TRACER?
  • Include an example with the Module API, as it's slightly different.
  • Document what the various MAX_PROFILING_ options do and how to set them from CMake.

Suggest a potential alternative/fix

Document the above bullet points.

cc @mergennachin @byjlw @Gasoonjia

Metadata

Metadata

Assignees

Labels

module: devtoolsIssues related to developer tools and code under devtools/module: docIssues related to documentation, both in docs/ and inlined in code

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions