Skip to content

Commit b9cbafd

Browse files
rajataryajsulzjulien-c
authored
Organize Hub Xet docs (#1969)
* Reorganized Xet docs, hopefully this renders ok * Add xet protocol subsection pages, finish toctree * Fix links in xet proto contents pages * quick fixes of some links * Reorganize Storage Backend docs * Fix TOC and link to xet protocol * Fix storage-backends rename * Update xet protocol to 1.0.0 * add xet protocol link to security * Update docs/hub/_redirects.yml add redirect for old storage-backends links Co-authored-by: Julien Chaumond <[email protected]> * Reorganizing TOC * PR feedback --------- Co-authored-by: Jared Sulzdorf <[email protected]> Co-authored-by: Julien Chaumond <[email protected]>
1 parent 6e176d4 commit b9cbafd

File tree

12 files changed

+146
-130
lines changed

12 files changed

+146
-130
lines changed

docs/hub/_redirects.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ api-webhook: webhooks
1818
adapter-transformers: adapters
1919
security-two-fa: security-2fa
2020
repositories-recommendations: storage-limits
21-
xet: storage-backends#xet
21+
xet: xet/index
22+
storage-backends: xet/index

docs/hub/_toctree.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,19 @@
4747
title: Repository Settings
4848
- local: storage-limits
4949
title: Storage Limits
50-
- local: storage-backends
51-
title: Storage Backends
50+
- local: xet/index
51+
title: Storage Backend (Xet)
52+
sections:
53+
- local: xet/overview
54+
title: Xet History & Overview
55+
- local: xet/using-xet-storage
56+
title: Using Xet Storage
57+
- local: xet/security
58+
title: Security
59+
- local: xet/legacy-git-lfs
60+
title: Backwards Compatibility & Legacy
61+
- local: xet/deduplication
62+
title: Deduplication
5263
- local: repositories-pull-requests-discussions
5364
title: Pull Requests & Discussions
5465
- local: notifications

docs/hub/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Hugging Face Hub is a platform with over 2M models, 500k datasets, and 1M de
2727
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./repositories-getting-started">Getting Started</a>
2828
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./repositories-settings">Repository Settings</a>
2929
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./storage-limits">Storage Limits</a>
30-
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./storage-backends">Storage Backends</a>
30+
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./xet/index">Storage Backend (Xet)</a>
3131
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./repositories-pull-requests-discussions">Pull requests and Discussions</a>
3232
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./notifications">Notifications</a>
3333
<a class="transform no-underline! transition-colors hover:translate-x-px hover:text-gray-700" href="./collections">Collections</a>
@@ -122,7 +122,7 @@ On it, you'll be able to upload and discover...
122122
- Spaces: _interactive apps for demonstrating ML models directly in your browser_
123123

124124
The Hub offers **versioning, commit history, diffs, branches, and over a dozen library integrations**!
125-
All repositories build on [Xet](https://huggingface.co/join/xet), a new technology to efficiently store Large Files inside Git, intelligently splitting files into unique chunks and accelerating uploads and downloads.
125+
All repositories build on [Xet](./xet/index), a new technology to efficiently store Large Files inside Git, intelligently splitting files into unique chunks and accelerating uploads and downloads.
126126

127127
You can learn more about the features that all repositories share in the [**Repositories documentation**](./repositories).
128128

docs/hub/repositories.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Models, Spaces, and Datasets are hosted on the Hugging Face Hub as [Git repositories](https://git-scm.com/about), which means that version control and collaboration are core elements of the Hub. In a nutshell, a repository (also known as a **repo**) is a place where code and assets can be stored to back up your work, share it with the community, and work in a team.
44

55
Unlike other collaboration platforms, our Git repositories are optimized for Machine Learning and AI files – large binary files, usually in specific file formats like Parquet and Safetensors, and up to [Terabyte-scale sizes](https://huggingface.co/blog/from-files-to-chunks)!
6-
To achieve this, we built [Xet](./storage-backends), a modern custom storage system built specifically for AI/ML development, enabling chunk-level deduplication, smaller uploads, and faster downloads.
6+
To achieve this, we built [Xet](./xet/index), a modern custom storage system built specifically for AI/ML development, enabling chunk-level deduplication, smaller uploads, and faster downloads.
77

88
<div class="flex justify-center">
99
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/xet-speed.gif"/>
@@ -17,7 +17,7 @@ In these pages, you will go over the basics of getting started with Git and Xet
1717
- [Getting Started with Repositories](./repositories-getting-started)
1818
- [Settings](./repositories-settings)
1919
- [Storage Limits](./storage-limits)
20-
- [Storage Backends](./storage-backends)
20+
- [Storage Backend (Xet)](./xet/index)
2121
- [Pull Requests & Discussions](./repositories-pull-requests-discussions)
2222
- [Pull Requests advanced usage](./repositories-pull-requests-discussions#pull-requests-advanced-usage)
2323
- [Collections](./collections)

docs/hub/storage-backends.md

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)