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

[Refactor] Rename Engine to MLCEngine #408

Merged
merged 1 commit into from
May 22, 2024

Conversation

CharlieFRuan
Copy link
Contributor

@CharlieFRuan CharlieFRuan commented May 22, 2024

We rename all Engine to MLCEngine to:

  1. Match naming scheme in https://github.com/mlc-ai/mlc-llm
  2. Better demonstrate the semantics of an Engine, especially when users do wildcard importing

To accommodate this breaking change, control-F Engine (with same capitalization) and replace with MLCEngine should suffice

@CharlieFRuan CharlieFRuan force-pushed the pr-0521-rename-engine branch from 808108b to 2a9237c Compare May 22, 2024 04:06
@CharlieFRuan CharlieFRuan merged commit 1d7c39b into mlc-ai:main May 22, 2024
CharlieFRuan added a commit that referenced this pull request May 22, 2024
This version bump is breaking as we renamed APIs.

### Changes
The only two changes are:
- Renamed all `Engine` to `MLCEngine`
  - #408
- See
https://github.com/mlc-ai/web-llm/pull/408/files#diff-a2a171449d862fe29692ce031981047d7ab755ae7f84c707aef80701b3ea0c80
fo the full list of changes
- To accommodate this breaking change, control-F `Engine` (with same
capitalization) and replace with `MLCEngine` should suffice
- Renamed ServiceWorker classes:
  - #403
  - WebServiceWorker -> ServiceWorker
  - ServiceWorker -> ExtensionServiceWorker

### WASM Version
v0_2_34 as no change is required.

### TVMjs
TVMjs compiled at
apache/tvm@a5862a5,
with no change
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.

1 participant