You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/hub/xet/using-xet-storage.md
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,15 +36,16 @@ Install [Git](https://git-scm.com/) and [Git LFS](https://git-lfs.com/).
36
36
37
37
### Install on macOS or Linux (amd64 or aarch64)
38
38
39
-
To install using [Homebrew](https://brew.sh/):
39
+
Install using an installation script with the following command in your terminal (requires `curl` and `unzip`):
40
40
```
41
-
brew tap huggingface/tap
42
-
brew install git-xet
41
+
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh
43
42
```
44
-
Or, using an installation script, run the following in your terminal (requires `curl` and `unzip`):
43
+
Or, install using [Homebrew](https://brew.sh/), with the following [tap](https://docs.brew.sh/Taps) (direct `brew install` coming soon):
45
44
```
46
-
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh
45
+
brew tap huggingface/tap
46
+
brew install git-xet
47
47
```
48
+
48
49
To verify the installation, run:
49
50
```
50
51
git-xet --version
@@ -65,6 +66,23 @@ To verity the installation, run:
65
66
git-xet --version
66
67
```
67
68
69
+
### Using Git Xet
70
+
71
+
Once installed on your platform, using Git Xet is as simple as following the Hub's standard Git workflows. First, make sure Git LFS is initialized in your local version of the repository:
72
+
73
+
```
74
+
git lfs install
75
+
```
76
+
Then make any additions you might want, commit your changes, and `push` your commit to the Hub:
77
+
78
+
```
79
+
# Create any files you like! Then...
80
+
git add .
81
+
git commit -m "Uploading new models" # You can choose any descriptive message
82
+
git push
83
+
```
84
+
Under the hood, the [Xet protocol](https://huggingface.co/docs/xet/index) is invoked to upload large files directly to Xet storage, increasing upload speeds through the power of [chunk-level deduplication](./deduplication).
0 commit comments