add tritonparse docs#133
Open
zhudada0120 wants to merge 1 commit into
Open
Conversation
CLA Signature Passzhudada0120, thanks for your pull request. All authors of the commits have signed the CLA. 👍 |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds initial Chinese Sphinx documentation for TritonParse, covering installation and a full “quick start” workflow (trace generation → parsing → web UI analysis).
Changes:
- Added
install.rstwith Ascend environment prerequisites and TritonParse installation/verification steps - Added
quick_start.rstwalking through tracing, parsing, web UI usage, and reproducer workflow - Added
index.rstto expose the new docs in the toctree
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| sources/tritonparse/index.rst | Adds a toctree entry point for the TritonParse docs |
| sources/tritonparse/install.rst | Documents install prerequisites and installation/verification commands |
| sources/tritonparse/quick_start.rst | Documents end-to-end usage: tracing, parsing, web UI, and reproducer |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 昇腾环境安装 | ||
| ---------------- | ||
|
|
||
| 在安装 TritonParse 之前，请根据已有昇腾产品型号及CPU架构等按照 `快速安装昇腾环境指引 <../ascend/quick_install>`_ 进行昇腾环境安装。 |
Comment on lines
+397
to
+398
| # 为第一个启动事件生成复现脚本 | ||
| tritonparseoss reproduce ./parsed_output/trace.ndjson --line 1 --out-dir repro_output |
|
|
||
| result = reproduce( | ||
| input_path="./parsed_output/trace.ndjson", | ||
| line_index=0, # 启动事件索引（从 0 开始） |
| - NDJSON 跟踪文件路径（``.ndjson`` 或 ``.ndjson.gz``） | ||
| - 必填 | ||
| * - ``--line`` | ||
| - 启动事件的行索引（从 0 开始） |
|
|
||
| - Python >= 3.10 | ||
| - Operating System: Linux, macOS, or Windows (with WSL recommended) | ||
| - Triton > 3.3.1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
add tritonparse docs