[v0.4.0] Release Tracker

[dvorjackz]

The v0.4.0 release will be cut from the "release/0.4" branch for critical fixes to the v0.4.0 release.

Branch Cut Date: 09/15/2024
Intended Release Date: 10/17/2024

This issue is for tracking cherry-picks to the release branch.

Cherry-Pick Criteria

Focus on stability and documentation correctness. Ideally only low risk changes may be cherry-picked from main:

1. Critical fixes in core components: build, exir, backends, runtime, sdk
2. Bug fixes in demos/examples. No new features/experiments
3. Critical bug fixes based on community feedback
4. Documentation improvements
5. Test/CI fixes
6. Release branch specific changes (e.g. change version identifiers)

Any core components changes and other change will require special dispensation from the release managers (currently @vmpuri @dvorjackz). If this applies to your change please write "Special Dispensation" in the "Criteria Category:" template below and explain.

Cherry-Pick Process

1. Ensure your PR has landed in master. This does not apply for release-branch specific changes (see Phase 1 criteria).

2. Create (but do not land) a PR against the release branch.
   Option 1: Use pytorchbot to cherry pick a PR that has been committed to the main branch using @pytorchbot cherry-pick command as follows.

   @pytorchbot cherry-pick --onto release/0.4 -c {regression,critical,fixnewfeature,docs,release}
   

   usage: @pytorchbot cherry-pick --onto ONTO [--fixes FIXES] -c
                            {regression,critical,fixnewfeature,docs,release}
   
   Cherry pick a pull request onto a release branch for inclusion in a release
   
   optional arguments:
     --onto ONTO           Branch you would like to cherry pick onto (Example: release/0.4)
     --fixes FIXES         Link to the issue that your PR fixes (i.e. https://github.com/pytorch/executorch/issues/2345)
     -c {regression,critical,fixnewfeature,docs,release}
                     A machine-friendly classification of the cherry-pick reason.
                     
   

   Option 2: Manually create a cherry pick PR using git command as follows.

   # Find the hash of the commit you want to cherry pick
   # (for example, abcdef12345)
   git log
   
   git fetch origin release/0.4
   git checkout release/0.4
   git cherry-pick -x abcdef12345
   
   # Submit a PR based against 'release/0.4' either:
   # via the GitHub UI
   git push my-fork
   
   # via the GitHub CLI
   gh pr create --base release/0.4
   
   

3. Make a request below with the following format:

Link to landed trunk PR:
* 

Link to release branch PR:
* 

Criteria category and reasons:
* 

1. Someone from the release team will reply with approved / denied or ask for more information.
2. If approved, someone from the release team will merge your PR once the tests pass. Do not land the release branch PR yourself.

Please note HUD Link with branch CI status and link to the HUD to be provided here.
HUD

Versions

0.4.0

[pytorchbot]

Link to landed trunk PR (if applicable):

• Add extra checks for the provided dim order and strides. #5377

Link to release branch PR:

• Add extra checks for the provided dim order and strides. #5390

Criteria Category:
Fixnewfeature -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Move type arg to the end to match Aten constructors. #5379

Link to release branch PR:

• Move type arg to the end to match Aten constructors. #5391

Criteria Category:
Fixnewfeature -

[pytorchbot]

Link to landed trunk PR (if applicable):

• [executorch] Update phi-3-mini lora export code and readme #5327

Link to release branch PR:

• [executorch] Update phi-3-mini lora export code and readme #5393

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• [doc][devtools][rename] New URL for developer tools tutorial #5384

Link to release branch PR:

• [doc][devtools][rename] New URL for developer tools tutorial #5401

Criteria Category:
Docs - Update the devtools tutorial URL to https://pytorch.org/executorch/main/tutorials/devtools-integration-tutorial.html

[pytorchbot]

Link to landed trunk PR (if applicable):

• Add a README.md for benchmarking infra #5403

Link to release branch PR:

• Add a README.md for benchmarking infra #5413

Criteria Category:
Docs - Intro and instructions of using benchmarking infra.

[pytorchbot]

Link to landed trunk PR (if applicable):

• Cast the vector from deduced type to desired type if needed. #5409

Link to release branch PR:

• Cast the vector from deduced type to desired type if needed. #5416

Criteria Category:
Fixnewfeature -

[pytorchbot]

Link to landed trunk PR (if applicable):

• [ExecuTorch] Reapply D62466496: Build optimized kernels with bf16 support and gate usage at runtime #5376

Link to release branch PR:

• [ExecuTorch] Reapply D62466496: Build optimized kernels with bf16 support and gate usage at runtime #5420

Criteria Category:
Fixnewfeature - bfloat16 gemm/gemv will go faster on ARM chips with BFDOT (M2 and later Macs, most recentish phones)

[pytorchbot]

Link to landed trunk PR (if applicable):

• Upgrade the coremltools version. #5425

Link to release branch PR:

• Upgrade the coremltools version. #5429

Criteria Category:
Fixnewfeature -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update readme to include OSS references #5433

Link to release branch PR:

• Update readme to include OSS references #5449

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Add convenience load methond for forward. #5446

Link to release branch PR:

• Add convenience load methond for forward. #5454

Criteria Category:
Fixnewfeature -

[kirklandsign]

Link to landed trunk PR (if applicable):

• Fix Android ExecuTorchDemo docs #5439

Link to release branch PR:

• Fix Android ExecuTorchDemo docs (#5439) #5456

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• [doc][devtools][rename] New URL for developer tools overview page #5385

Link to release branch PR:

• [doc][devtools][rename] New URL for developer tools overview page #5457

Criteria Category:
Docs - Update the devtools overview page URL to https://pytorch.org/executorch/main/devtools-overview.html (used to be ....sdk-overview.html)

[pytorchbot]

Link to landed trunk PR (if applicable):

• [executorch][docs] Update stories cmd to use kv cache #5460

Link to release branch PR:

• [executorch][docs] Update stories cmd to use kv cache #5466

Criteria Category:
Docs -

[kirklandsign]

Link to landed trunk PR (if applicable):

• Clean up Android prebuilt artifact path and verification #6181

Link to release branch PR:

• Clean up Android prebuilt artifact path and verification #6182

Criteria Category:
Docs

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update and fix docs (namespaces, consistency) #6084

Link to release branch PR:

• Update and fix docs (namespaces, consistency) #6185

Criteria Category:
Docs - Does not need to be in the 0.4.0 RC, but doesn't hurt either. This should be included in the 0.4 website, though.

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update runtime tutorial to promode Module APIs in the beginning. #6198

Link to release branch PR:

• Update runtime tutorial to promode Module APIs in the beginning. #6216

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update XNNPACK docs to use to_edge_transform_and_lower API #5344

Link to release branch PR:

• Update XNNPACK docs to use to_edge_transform_and_lower API #6244

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update the "This is an alpha release" wording to "this is beta release" #6217

Link to release branch PR:

• Update the "This is an alpha release" wording to "this is beta release" #6258

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update landing page to include Llama (#6218) #6231

Link to release branch PR:

• Update landing page to include Llama (#6218) #6259

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Point to to_edge_transform_and_lower in ExecuTorch API docs #6236

Link to release branch PR:

• Point to to_edge_transform_and_lower in ExecuTorch API docs #6283

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Update mediatek_README.md #6290

Link to release branch PR:

• Update mediatek_README.md #6294

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Bump branch version in docs. #6305

Link to release branch PR:

• Bump branch version in docs. #6306

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• LLM manual fixes on profiling part #6299

Link to release branch PR:

• LLM manual fixes on profiling part #6315

Criteria Category:
Docs - This PR adds a temporary fix for the flatccrt build error in the LLM manual.

[pytorchbot]

Link to landed trunk PR (if applicable):

• Add placeholder runtime/COMPATIBILITY.md #6307

Link to release branch PR:

• Add placeholder runtime/COMPATIBILITY.md #6316

Criteria Category:
Docs -

[pytorchbot]

Link to landed trunk PR (if applicable):

• Add a null check for tracer in the Module::load_method #6298

Link to release branch PR:

• Add a null check for tracer in the Module::load_method #6319

Criteria Category:
regression - Fix etdump generation

[mergennachin]

Link to landed trunk PR:

• N/A

Link to release branch PR:

• Git clone instruction with release/0.4 branch #6323

Criteria category and reasons:

• docs

[pytorchbot]

Link to landed trunk PR (if applicable):

• [pybind] Add pybind API reference docs #6276

Link to release branch PR:

• [pybind] Add pybind API reference docs #6328

Criteria Category:
Docs -

[mergennachin]

We can close this now that 0.4 is released

https://github.com/pytorch/executorch/releases/tag/v0.4.0