You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by "vacu9708 (via GitHub)" <gi...@apache.org> on 2025/07/09 16:22:21 UTC

[PR] [Relax][Doc] Visualize Relax [tvm]

vacu9708 opened a new pull request, #18128:
URL: https://github.com/apache/tvm/pull/18128

   # Summary
   I thought that visually representing each TVM component would help new contributors understand the architecture, lower the barrier to entry, and ultimately speed up development.
   
   # Candidate diagrams
   I created two diagrams illustrating the same workflow—a block diagram and a UML sequence diagram—and I’d appreciate your feedback on which is more effective.
   
   **Block diagram**
   [relax-block_diagram.drawio.txt](https://github.com/user-attachments/files/21146669/relax-block_diagram.drawio.txt)
   ![relax-block_diagram](https://github.com/user-attachments/assets/8fe4ce9a-4ed0-44bc-ad6b-599f272f4f81)
   
   **UML sequence diagram**
   [relax-sequence_diagram.puml.txt](https://github.com/user-attachments/files/21146687/relax-sequence_diagram.puml.txt)
   ![relax-sequence_diagram](https://github.com/user-attachments/assets/58b3ca96-6aa0-4d22-b798-4bb32ef2dc81)
   
   # Changes
   - Add a diagram to the document to visually represent interactions between Relax components and their dependencies
   - Fix typos
   
   
   - Since this is my first time uploading images to the docs, please let me know if anything needs adjusting.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Doc] Visualize the architecture using a UML sequence diagram [tvm]

Posted by "Hzfengsy (via GitHub)" <gi...@apache.org>.
Hzfengsy commented on PR #18128:
URL: https://github.com/apache/tvm/pull/18128#issuecomment-3057740043

   Thanks @tqchen, I agree that we don't want to focus on a single compilation path. However, it would be good to have documentation for common practice, I think those documents PR should be welcomed by the community


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Doc] Visualize the architecture using a UML sequence diagram [tvm]

Posted by "tqchen (via GitHub)" <gi...@apache.org>.
tqchen commented on PR #18128:
URL: https://github.com/apache/tvm/pull/18128#issuecomment-3057297030

   Thanks @vacu9708 , the main issue is that we don't want to focus on a single flow, for example, meta-schedule step can be optional, and we would like to focus on the general setups, e.g. what would the flow and API looks like.
   
   The particular examples are helpful for case studies, maybe in future if we have developer guides for case study of a certain target dependent flow as we introduced in https://discuss.tvm.apache.org/t/relax-target-default-pipeline/18043, then having some steps can be helpful


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Relax][Doc] Visualize Relax [tvm]

Posted by "tqchen (via GitHub)" <gi...@apache.org>.
tqchen commented on PR #18128:
URL: https://github.com/apache/tvm/pull/18128#issuecomment-3053334714

   usually we don't include the image source in the tree to avoid binary blob, in the past we sent images to repos like https://github.com/tlc-pack/web-data and refer to them. the general philosophy docs that centeralizes IRModule would help , perhaps with some related materials in https://mlc.ai/


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Relax][Doc] Visualize Relax [tvm]

Posted by "vacu9708 (via GitHub)" <gi...@apache.org>.
vacu9708 commented on PR #18128:
URL: https://github.com/apache/tvm/pull/18128#issuecomment-3056339068

   I understand your point that the detailed diagrams for each TVM module are unnecessary.
   
   I’ve now created a more abstract UML sequence diagram that centralizes the IRModule.
   Would this help lower the barrier to entry for new contributors?
   - If so, I’ll update the commit for the docs to include it below the "Overall Flow" image.
   - Otherwise, I’ve left only the typo fixes in the commit. Could this commit be merged?
   
   ![relax-sequence_diagram](https://github.com/user-attachments/assets/5832148f-62e3-4007-b659-3409d938551e)
   [relax-sequence_diagram.puml.txt](https://github.com/user-attachments/files/21157670/relax-sequence_diagram.puml.txt)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Doc] Visualize the architecture using a UML sequence diagram [tvm]

Posted by "tqchen (via GitHub)" <gi...@apache.org>.
tqchen merged PR #18128:
URL: https://github.com/apache/tvm/pull/18128


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Doc] Visualize the architecture using a UML sequence diagram [tvm]

Posted by "vacu9708 (via GitHub)" <gi...@apache.org>.
vacu9708 commented on PR #18128:
URL: https://github.com/apache/tvm/pull/18128#issuecomment-3056383235

   @tqchen  I understand your point that the detailed diagrams for each TVM module are unnecessary.
   
   I’ve now created a more abstract UML sequence diagram that centralizes the IRModule.
   Would this help lower the barrier to entry for new contributors?
   - If so, I’ll update the commit for the docs to include it below the "Overall Flow" image.
   - Otherwise, I’ve left only the typo fixes in the commit. Could this commit be merged?
   
   ![relax-sequence_diagram](https://github.com/user-attachments/assets/0be38d8f-1b7c-4604-91d5-4a0f002a7034)
   [relax-sequence_diagram.puml.txt](https://github.com/user-attachments/files/21157670/relax-sequence_diagram.puml.txt)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org