Improve documentation for new migraphx developers
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 333
- Forks
- 150
- Avg merge
- 4d 19h
- Merged PRs (30d)
- 54
Description
In general, we are missing a lot of details that would make the developer documentation useful. I'm okay with this as a first pass, but we need at least descriptions of the following:
- current compiler passes within MIGraphX
- how to add compiler passes (subsequently, how to manipulate the current program and insert/replace instructions)
- how to use multiple modules
- how to add new operators
- how the onnx and tf parsers work
- how serialization works
- how matchers work
- debugging
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Use the issue's topic list to define the documentation scope: compiler passes, pass creation and program manipulation, modules, operators, parsers, serialization, matchers, and debugging. Review the existing developer documentation and organize explanations for each topic; done means new MIGraphX developers can use the documentation to understand and extend these areas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100