Skip to content

Commit adb1284

Browse files
julien-csguggerPierrci
committed
README tweaks (#3)
* first version of README * Apply suggestions from @sgugger Co-authored-by: Sylvain Gugger <[email protected]> * suggestion from @Pierrci Co-authored-by: Pierric Cistac <[email protected]> * rm mention of lfs custom agents... Co-authored-by: Sylvain Gugger <[email protected]> Co-authored-by: Pierric Cistac <[email protected]>
1 parent 396bc14 commit adb1284

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Check out the source code for all possible params (we'll create a real doc page
6262
Uploading a model to the hub is super simple too:
6363
- create a model repo directly from the website, at huggingface.co/new (models can be public or private, and are namespaced under either a user or an organization)
6464
- clone it with git
65-
- install [lfs](https://git-lfs.github.com/) with `git lfs install` if you haven't done that before
65+
- [download and install git lfs](https://git-lfs.github.com/) if you don't already have it on your machine (you can check by running a simple `git lfs`)
6666
- add, commit and push your files, from git, as you usually do.
6767

6868
**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.**
@@ -86,17 +86,15 @@ huggingface-cli repo create
8686

8787
### Need to upload large (>5GB) files?
8888

89-
To upload large files (>5GB 🔥), you need to install the custom transfer agent for git-lfs, bundled in this package. Spec for LFS custom transfer agent is:
90-
https://github.com/git-lfs/git-lfs/blob/master/docs/custom-transfers.md
89+
To upload large files (>5GB 🔥), you need to install the custom transfer agent for git-lfs, bundled in this package.
9190

9291
To install, just run:
9392

9493
```bash
9594
$ huggingface-cli lfs-enable-largefiles
9695
```
9796

98-
This should be executed once for each model repo that contains a model file >5GB. It's documented in the error
99-
message you get if you just try to git push a 5GB file without enabling it before.
97+
This should be executed once for each model repo that contains a model file >5GB. If you just try to push a file bigger than 5GB without running that command, you will get an error with a message reminding you to run it.
10098

10199
Finally, there's a `huggingface-cli lfs-multipart-upload` command but that one is internal (called by lfs directly) and is not meant to be called by the user.
102100

0 commit comments

Comments
 (0)