Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Introduce Relax API and move legacy part to standalone page #17286

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

Hzfengsy
Copy link
Member

As the TVM project evolves, the Unity strategy has been the recommended way to use Apache TVM applications. Hence, we are pushing documentation for the Relax API to the forefront and moving the legacy part to a standalone page, which may be removed in the future.

cc @tqchen

@Hzfengsy
Copy link
Member Author

Hzfengsy commented Aug 20, 2024

an online preview at http://8.130.134.126:58000/relax_api/

As the TVM project evolves, the Unity strategy has been the recommended
way to use Apache TVM applications. Hence, we are pushing documentation
for the Relax API to the forefront and moving the legacy part to a
standalone page, which may be removed in the future.
@quic-sanirudh
Copy link
Contributor

Hi, this is great, thanks for this.

One thing I noticed was that the Design and Architecture section has also gone into legacy part. This contains some very useful documentation about the TVM Runtime, PackedFunc, TVM Object stack, etc. which could be very useful for beginners.

It also contains relay specific details which is probably legacy, but perhaps we could clean that up and move the runtime specific details out of legacy part? It could be done as a follow-up task as well, but I just noticed that and thought it might be useful to retain those docs outside legacy part.

@tqchen
Copy link
Member

tqchen commented Aug 20, 2024

thanks @quic-sanirudh for great suggestion, yes, i think we can followup to bring up some of the FFI and Object systems

@Hzfengsy
Copy link
Member Author

@quic-sanirudh Thanks for the great suggestion. I agree that some parts are still valuable. However, the current doc is coupled with Relay, and it is not easy to clean it out. I will get them back in a following PR.

@tqchen tqchen merged commit 9e865b4 into apache:main Aug 22, 2024
18 of 19 checks passed
@Hzfengsy Hzfengsy deleted the relax_api_ref branch August 27, 2024 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants