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

[Docs] Add useful links to model sharing #9431

Merged
merged 1 commit into from
Jan 6, 2021

Conversation

patrickvonplaten
Copy link
Contributor

@patrickvonplaten patrickvonplaten commented Jan 6, 2021

What does this PR do?

This PR extends the model_sharing doc by two additional links that point to helper scripts to more efficiently change multiple configs and upload organization-specific repos.
Since some people have been asking for these kinds of scripts, I think it makes sense to link them here.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors which may be interested in your PR.

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for adding those!

@patrickvonplaten patrickvonplaten merged commit b972c1b into huggingface:master Jan 6, 2021
This creates a repo on the model hub, which can be cloned.
This creates a repo on the model hub, which can be cloned. If you want to create a repo under a specific organization,
you might find the `upload_a_new_repo.py script
<https://github.com/huggingface/efficient_scripts/blob/main/upload_a_new_repo.py>`__ useful.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this should be here. Wouldn't it be more logical to write:

If you want to create a repo under a specific organization:

transformers-cli repo create your-model-name --organization your-org-name

Here's a script that exposes the API calls that we do in case you want to do it programmatically:

(your link)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh yeah, you're completely right (should have waited before merging :-/) Didn't check that the --organization flag exists. I'll fix that tomorrow :-)

@@ -98,8 +100,10 @@ with any other git repo.
echo "hello" >> README.md
git add . && git commit -m "Update from $USER"

We are intentionally not wrapping git too much, so that you can go on with the workflow you're used to and the tools
you already know.
If you want to change multiple repos at once, the `change_config.py script
Copy link
Member

Choose a reason for hiding this comment

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

Put this sentence at the end?

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.

3 participants