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

Audit and update the pip package metadata #3265

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

dbort
Copy link
Contributor

@dbort dbort commented Apr 24, 2024

Fill out the recommended project keys, most of which will affect the web page that PyPI will render for the executorch package.

See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#about-your-project for the latest guidance.

Use https://github.com/pytorch/pytorch/blob/a21327e0b03cc18850a0608be2d9c5bd38fd4646/setup.py#L1394 as a guide for the actual values.

Add a README-wheel.md file that will be included in the wheel, and will become the main page contents on PyPI.

Test Plan:

  • Installed the package with ./install_requirements.sh
  • Looked at the files under ~/miniconda3/envs/executorch/lib/python3.10/site-packages/executorch-0.2.0a0+1a499e0.dist-info. METADATA and LICENSE both contain the new metadata.

Fill out the recommended `project` keys, most of which will affect the
web page that PyPI will render for the `executorch` package.

See
https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#about-your-project
for the latest guidance.

Use
https://github.com/pytorch/pytorch/blob/a21327e0b03cc18850a0608be2d9c5bd38fd4646/setup.py#L1394
as a guide for the actual values.

Add a README-wheel.md file that will be included in the wheel, and will
become the main page contents on PyPI.

Test Plan:
* Installed the package with `./install_requirements.sh`
* Looked at the files under ~/miniconda3/envs/executorch/lib/python3.10/site-packages/executorch-0.2.0a0+1a499e0.dist-info. METADATA and LICENSE both contain the new metadata.
Copy link

pytorch-bot bot commented Apr 24, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/3265

Note: Links to docs will display an error until the docs builds have been completed.

❌ 1 New Failure

As of commit 2a89416 with merge base d3326a2 (image):

NEW FAILURE - The following job has failed:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 24, 2024
Copy link
Contributor

@guangy10 guangy10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Dave!

Started](https://pytorch.org/executorch/stable/getting-started-setup.html)
* Set up the ExecuTorch environment and run PyTorch models locally.
* [Working with
local LLMs](https://pytorch.org/executorch/stable/llm/getting-started.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These llm URLs don't work yet, but they will when we go live. I tested by replacing "stable" with "0.2" in each URL -- when we go live, we'll update the "stable" symlink to point to "0.2" in the gh-pages branch.

@guangy10
Copy link
Contributor

There are bunch of CI failures you will need to look into. Please ensure it's addressed before merging

@dbort
Copy link
Contributor Author

dbort commented Apr 24, 2024

@guangy10 doh, the torch==2.3 is breaking assumptions in the CI environment. This is the requirement that we need when we release, but right now it can't be fulfilled.

I updated this PR to only touch the metadata without adding that dependency line. I'll need to modify the CI scripts to make this work.

@dbort dbort mentioned this pull request Apr 24, 2024
@dbort
Copy link
Contributor Author

dbort commented Apr 24, 2024

I'm not sure why the lint job is failing. Some of the suggestions it's giving look wrong, and I don't see those same suggestions when running locally. I'm re-running the job to see if it was temporary.

EDIT: It was because of the new "python >=3.10" requirement. There's a new with syntax in 3.10+ that the linter started enforcing. #3277 will remove the >=3.10 since we do actually want to try supporting older versions at some point

@dbort
Copy link
Contributor Author

dbort commented Apr 24, 2024

Trying to reinstate the torch==2.3 dependency in #3277

@guangy10
Copy link
Contributor

Yeah, this PR doesn't even touch those files.

@guangy10 guangy10 merged commit d1cf0a6 into pytorch:release/0.2 Apr 24, 2024
34 of 35 checks passed
@dbort dbort deleted the pip-metadata branch April 24, 2024 17:10
@mergennachin mergennachin mentioned this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants