[Debt] Make tvmjs an npm package, simplify build from source #570
Conversation
This file contains 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
CharlieFRuan
added a commit
that referenced
this pull request
Sep 23, 2024
No breaking changes or API-related changes. ### Changes - #571 - #570 - This is the major change in this version, where we now depend on the packaged TVMjs: `@mlc-ai/web-runtime`. This only changes how users build WebLLM from source - Since `@mlc-ai/web-runtime` is not an official package from `apache/tvm`, we record the commit that it is built upon in the WebLLM version bump PR, like below ### TVMjs - Version `0.18.0-dev0` - Built at apache/tvm@30fb16a
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.
In the past, building WebLLM from source could be cumbersome as users needed to build TVMjs by themselves by setting up
emscriptenand running./scripts/prep_deps.sh, while TVMjs is, most of the time, not where the users may want to modify the code.This PR modifies
package.json's"tvmjs": "file:./tvm_home/web",to"@mlc-ai/tvmjs": "0.18.0-dev0",, as we uploaded TVMjs as an npm package, so users no longer need to run./scripts/prep_deps.sh.We update
README.md's directions for building from source accordingly.Users can still build TVMjs from source with similar steps as before, as described in the
README.md.Note that an extra step required by this change is addressing
"import require$$4 from 'ws'"andconst WebSocket = require(\"ws\")inlib/index.jsandlib/index.js.mapafternpm run build. We take care of it incleanup-idnex-js.shby following similar measures forperf_hooks.