Skip to content

Commit e8c859c

Browse files
committed
fix some local links
1 parent ef50638 commit e8c859c

File tree

4 files changed

+5
-6
lines changed

4 files changed

+5
-6
lines changed

docs/hub/xet/deduplication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Each chunk has its content hashed using a cryptographic hash function (Blake3-ba
147147

148148
### Xorb Formation
149149

150-
When new chunks need to be stored, they are aggregated into xorbs based on size and count limits. If adding a new chunk would exceed the maximum xorb size or chunk count, the current xorb is finalized and uploaded. [See section about xorb formation](../xorb)
150+
When new chunks need to be stored, they are aggregated into xorbs based on size and count limits. If adding a new chunk would exceed the maximum xorb size or chunk count, the current xorb is finalized and uploaded. [See section about xorb formation](./xorb)
151151

152152
### File Reconstruction Information
153153

docs/hub/xet/download-protocol.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ To download a file given a file hash, first call the reconstruction API to get t
1717

1818
Note that you will need at least a `read` scope auth token, [auth reference](./auth).
1919

20+
> [!TIP]
2021
> For large files it is RECOMMENDED to request the reconstruction in batches i.e. the first 10GB, download all the data, then the next 10GB and so on. Clients can use the `Range` header to specify a range of file data.
2122
2223
## Stage 2: Understanding the Reconstruction Response
@@ -25,8 +26,6 @@ The reconstruction API returns a `QueryReconstructionResponse` object with three
2526

2627
### QueryReconstructionResponse Structure
2728

28-
Scroll
29-
3029
```json
3130
{
3231
"offset_into_first_range": 0,
@@ -172,7 +171,7 @@ The downloaded data is in xorb format and MUST be deserialized:
172171
3. **Extract byte indices**: Track byte boundaries between chunks for range extraction
173172
4. **Validate length**: Decompressed length MUST match `unpacked_length` from the term
174173

175-
**Note**: The specific deserialization process depends on the [Xorb format](../xorb).
174+
**Note**: The deserialization process depends on the [Xorb format](./xorb).
176175

177176
```python
178177
for term in terms:

docs/hub/xet/shard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ struct FileDataSequenceEntry {
260260

261261
Verification Entries MUST be set for shard uploads.
262262

263-
To generate verification hashes for shard upload read the section about [Verification Hashes](../hashing#Term%20Verification%20Hashes).
263+
To generate verification hashes for shard upload read the section about [Verification Hashes](./hashing#Term-Verification-Hashes).
264264

265265
```rust
266266
struct FileVerificationEntry {

docs/hub/xet/xorb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Note that a Xorb MAY contain chunks that utilize different compression schemes.
111111
2. **Best Effort Prediction**
112112

113113
In `xet-core`, to predict if BG4 will be useful we maximum KL divergence between the distribution of per-byte pop-counts on a sample of each of the 4 groups that would be formed.
114-
You can read more about it in [bg4_prediction.rs](../cas_object/src/byte_grouping/bg4_prediction.rs) and accompanying scripts.
114+
You can read more about it in [bg4_prediction.rs](./cas_object/src/byte_grouping/bg4_prediction.rs) and accompanying scripts.
115115

116116
If the predictor does not show that BG4 will be better, we use Lz4 and in either case we will store the chunk as the uncompressed version if the compression scheme used does not show any benefit.
117117

0 commit comments

Comments
 (0)