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

Add HF CLI Upload to E2E Workflow tutorial #773

Merged
merged 5 commits into from
Apr 17, 2024

Conversation

joecummings
Copy link
Contributor

@joecummings joecummings commented Apr 16, 2024

Context

Changelog

  • Add section to E2E workflow tutorial
  • Remove hf_upload directory

Test plan

  • Eyes
Screenshot 2024-04-16 at 1 44 17 PM

Copy link

pytorch-bot bot commented Apr 16, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/torchtune/773

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

✅ No Failures

As of commit 3b7ce63 with merge base e9e082e (image):
💚 Looks good so far! There are no failures yet. 💚

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 16, 2024
--------------------------------------------

Your new model is working great and you want to share it with the world. The easiest way to do this
is utilizing the ``huggingface-cli`` command, which is integrated with torchtune. Simply point the CLI
Copy link
Member

Choose a reason for hiding this comment

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

nit: I don't believe it's integrated anymore, its more like interops or works seamlessly with

@@ -1,125 +0,0 @@
LLAMA 2 COMMUNITY LICENSE AGREEMENT
Copy link
Member

Choose a reason for hiding this comment

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

so this was here on purpose but it's an artifact of when we only supported llama2


.. code-block:: bash

huggingface-cli upload <hf-repo-id> <checkpoint-dir>
Copy link
Member

Choose a reason for hiding this comment

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

nit: mention where the checkpoint will be saved by default

Copy link
Member

@msaroufim msaroufim left a comment

Choose a reason for hiding this comment

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

LGTM but I'll let @matthewdzmura comment on what to do about the licensing change

Copy link

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Thanks @joecummings!


.. note::

Before uploading, make sure you are authenticated with Hugging Face by running ``huggingface-cli login``.
Copy link

Choose a reason for hiding this comment

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

FYI, You can also mention the "authentication" section from the quickstart guide (https://huggingface.co/docs/huggingface_hub/quick-start#authentication). And yeah, huggingface-cli login is perfectly valid!

@joecummings joecummings merged commit 4ef3be3 into main Apr 17, 2024
27 checks passed
@joecummings joecummings deleted the add-hf-cli-to-e2e-tutorial branch April 17, 2024 14:24
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.

4 participants