Update HolisticTraceAnalysis dependency to the traceinsight package by tejadhith · Pull Request #217 · mlcommons/chakra

tejadhith · 2026-07-07T17:37:00Z

Summary

Chakra pins HolisticTraceAnalysis (HTA) to git commit d731cc2e in pyproject.toml, in both CI workflows (python_tests, end_to_end_tests), and in USER_GUIDE.md. That mid-2024 checkpoint predates HTA's pandas-2.x compatibility fix (HTA PR #333), so running chakra_trace_link on a real trace logs Critical path analysis encountered an invalid graph structure: Cannot specify both 'axis' and 'index'/'columns' and silently skips critical-path analysis.

HTA now publishes its releases to PyPI under the renamed distribution traceinsight (0.6.0 / 0.6.1); the importable module remains hta, so no source changes are needed. This PR replaces the pinned git checkout with the traceinsight package across pyproject.toml, both CI workflows, and USER_GUIDE.md — which also removes the manual clone/submodule/editable-install step from CI.

Test Plan

Environment: Python 3.13, torch 2.9.0+cu128, 2× V100; traceinsight 0.6.1, PARAM et_replay, networkx 3.6.1.

Unit suite: python -m pytest tests → 117 passed (no regression).
End-to-end, single-rank MLP: chakra_trace_link →
- before (HTA 0.5.0): Cannot specify both 'axis' and 'index'/'columns', critical path skipped.
- after (traceinsight 0.6.1): calculating critical path took 0.0027s, Linking process successful; chakra_converter → valid .et (115 COMP_NODE).
End-to-end, 2-rank DDP/NCCL: link + convert succeed; .et = 154 COMP_NODE + 1 METADATA_NODE + 2 COMM_COLL_NODE (ncclDevKernel_AllReduce_…); critical path runs. No regression on comm-heavy traces.
import hta still resolves (module name unchanged in traceinsight 0.6.x).

Additional Notes

HTA's PyPI distribution was renamed HolisticTraceAnalysis → traceinsight at 0.6.x; the importable module stays hta. traceinsight only exists at 0.6.0+, so a bare requirement cannot resolve below the fix.
No networkx change: the DiGraph.__new__ crash was specific to networkx 3.6.0 (networkx #8367) and is fixed in 3.6.1; nothing forces 3.6.0.
A new mlc-chakra PyPI release is needed to propagate this to pip install mlc-chakra users.
Refs: HTA PR #333 (pandas 2.x fix), networkx #8367.

github-actions · 2026-07-07T17:37:12Z

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

jinsun-yoo

Thank you for the work. As a sanity check, coud you run the MLA conversion once more using the old version dependencies (networkx before 3.2.0, etc.), so that the generated Chakra graph stays the same before & after this change?

jinsun-yoo · 2026-07-09T15:26:13Z

-        git submodule update --init
-        pip install -r requirements.txt
-        pip install -e .
+        pip install traceinsight


Since this is now fixed to be a one-liner and is now represented in the requirements list in pyproject, perhaps we can remove this 'run item' altogether

jinsun-yoo · 2026-07-09T15:26:23Z

    - name: Install HTA
      run: |
-        git clone https://github.com/facebookresearch/HolisticTraceAnalysis.git
-        cd HolisticTraceAnalysis
-        git checkout d731cc2e2249976c97129d409a83bd53d93051f6
-        git submodule update --init
-        pip install -r requirements.txt
-        pip install -e .
+        pip install traceinsight


jinsun-yoo · 2026-07-09T15:27:13Z


 ### Step 4: Install Holistic Trace Analysis
-Installing Holistic Trace Analysis is necessary for Trace link.
+Installing Holistic Trace Analysis (published on PyPI as `traceinsight`) is necessary for Trace link.


Let's clarify: "published on PyPI as traceinsight - the old PyPi name HolisticTraceAnalysis is no longer valid"

remove this section too and the command below, let it happen directly with pypi pyproject.toml

jinsun-yoo · 2026-07-09T15:27:32Z

@@ -36,15 +36,10 @@ $ pip install .
 ```

 ### Step 4: Install Holistic Trace Analysis


Actually, similar to above comments, just remove this?

jinsun-yoo · 2026-07-09T15:27:46Z

    "networkx",
    "pydot",
-    "HolisticTraceAnalysis @ git+https://github.com/facebookresearch/HolisticTraceAnalysis.git@d731cc2e2249976c97129d409a83bd53d93051f6"
+    "traceinsight"


Let's add a comment here clarifying this is HTA

also maybe set a specific version in case HTA makes some changes?

jinsun-yoo · 2026-07-09T15:28:06Z

@@ -19,7 +19,7 @@ dependencies = [
    "graphviz",
    "networkx",


should we add >=3.6.1?

mihncalo · 2026-10-22T13:48:41Z

Environment used for testing

Python 3.13, torch 2.9.0+cu128, traceinsight 0.6.1, PARAM et_replay, networkx 3.6.1.

How the testing was done

Updated pyproject.toml to use requires-python 3.10 and ruff target-version py310, to prepare the environment ( these changes will come from the PR for Issue Raise requires-python to >=3.10 #224 )
Created a clean environment using python 3.13.17, to test with both pandas 2.x and 3.x
Followed the USER_GUIDE.md
Ran python -m pytest tests: All 117 tests are passing, 1 warning: DeprecationWarning: Python 3.14 will, by default, filter extracted tar archives and reject files or modify their metadata. Use the filter argument to control this behavior
Ran the simple_onerank.py and simple_multirank.py scripts in trace_collection/post_execution/ to generate the required traces
Ran chakra_trace_link using both pandas 2.3.3 and pandas 3.0.6 and collected the logs
Ran chakra_converter on the resulted linked traces to generate the .et files and collected the logs

Results

The logs show that:

critical path runs: critical_path_analysis.py:1487 [INFO]: calculating critical path took 0.001714 seconds
the host and device traces are linked successfully: Linking process successful. Output file is available at ...
the linked traces are converted into .et files successfully: Conversion successful. Output file is available at ...

Additional Notes

Pandas 3.x needs at least python 3.11, which means that requires-python will need to be raised in the future.

theodorbadea · 2026-10-22T14:05:27Z

Maybe we could pin pandas to 2.3.3 or <2.3.3 for now to avoid the possible conflict.

jinsun-yoo · 2026-10-27T18:03:58Z

Related to #225 why not just pin 225 to 3.11?

briancoutinho · 2026-10-31T01:28:23Z

Sorry if this is a late comment but should we consider using uv instead for the installation?
Most projects are now moving to uv instead of pip.

Update HolisticTraceAnalysis dependency to the traceinsight package

235826d

tejadhith requested a review from a team as a code owner July 7, 2026 17:37

jinsun-yoo requested changes Jul 9, 2026

View reviewed changes

theodorbadea mentioned this pull request Oct 16, 2026

Raise requires-python to >=3.10 #224

Open

This was referenced Oct 22, 2026

Raise python version to 3.10 #225

Open

Raised requires-python from 3.7 to 3.10 Keysight/chakra#2

Closed

This was referenced Oct 26, 2026

Pr 217 Keysight/chakra#3

Closed

Update HTA dependency to the traceinsight package #233

Open

		@@ -36,15 +36,10 @@ $ pip install .
		```

		### Step 4: Install Holistic Trace Analysis

Conversation

tejadhith commented Jul 7, 2026

Summary

Test Plan

Additional Notes

Uh oh!

github-actions Bot commented Jul 7, 2026

Uh oh!

jinsun-yoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mihncalo commented Oct 22, 2026

Environment used for testing

How the testing was done

Results

Additional Notes

Uh oh!

theodorbadea commented Oct 22, 2026

Uh oh!

jinsun-yoo commented Oct 27, 2026

Uh oh!

briancoutinho commented Oct 31, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants