Huggingface.js documentation

Interface: ParallelDownloadOptions

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Interface: ParallelDownloadOptions

Properties

controllerTickMs

Optional controllerTickMs: number

Concurrency controller tick interval, for tests and benchmarks.

Defined in

packages/hub/src/utils/XetBlob.ts:69


maxConcurrency

Optional maxConcurrency: number

Ceiling for the auto-tuned number of concurrent xorb requests.

Default

8

Defined in

packages/hub/src/utils/XetBlob.ts:55


maxInFlightBytes

Optional maxInFlightBytes: number

Budget of downloaded-but-not-yet-consumed bytes.

Default

derived from the file's reconstruction: 3x the largest xorb fetch, clamped to [64MB, 256MB]

Defined in

packages/hub/src/utils/XetBlob.ts:61


onStat

Optional onStat: (stat: Record<string, unknown>) => void

Instrumentation callback for tests and benchmarks, called once per download.

Type declaration

▸ (stat): void

Parameters
NameType
statRecord<string, unknown>
Returns

void

Defined in

packages/hub/src/utils/XetBlob.ts:65

Update on GitHub