Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / transformers.js /pr_1665 /en /api /utils /hub.html

HuggingFaceDocBuilder

10 days ago

download

raw

18.1 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"utils/hub","local":"utilshub","sections":[{"title":"Type Definitions","local":"type-definitions","sections":[{"title":"ExternalData","local":"externaldata","sections":[],"depth":3},{"title":"PretrainedOptions","local":"pretrainedoptions","sections":[],"depth":3},{"title":"ModelSpecificPretrainedOptions","local":"modelspecificpretrainedoptions","sections":[],"depth":3},{"title":"PretrainedModelOptions","local":"pretrainedmodeloptions","sections":[],"depth":3}],"depth":2}],"depth":1}">
	<link href="/docs/transformers.js/pr_1665/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/entry/start.cb58eb6f.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/scheduler.6efaaf90.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/singletons.08239980.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/paths.611c3944.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/entry/app.9eafcf9d.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/preload-helper.4b821645.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/index.eb3e1f0f.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/nodes/0.d361a553.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/nodes/18.fd528983.js">
	<link rel="modulepreload" href="/docs/transformers.js/pr_1665/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.699f2734.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"utils/hub","local":"utilshub","sections":[{"title":"Type Definitions","local":"type-definitions","sections":[{"title":"ExternalData","local":"externaldata","sections":[],"depth":3},{"title":"PretrainedOptions","local":"pretrainedoptions","sections":[],"depth":3},{"title":"ModelSpecificPretrainedOptions","local":"modelspecificpretrainedoptions","sections":[],"depth":3},{"title":"PretrainedModelOptions","local":"pretrainedmodeloptions","sections":[],"depth":3}],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div> <h1 class="relative group"><a id="utilshub" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#utilshub"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>utils/hub</span></h1> <p data-svelte-h="svelte-1jxl61c">Utility functions to interact with the Hugging Face Hub (<a href="https://huggingface.co/models" rel="nofollow">https://huggingface.co/models</a>)</p> <h2 class="relative group"><a id="type-definitions" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#type-definitions"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Type Definitions</span></h2> <a id="module_utils/hub.ExternalData"></a> <h3 class="relative group"><a id="externaldata" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#externaldata"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>ExternalData</span></h3> <p data-svelte-h="svelte-1swr7m">Specifies whether to load the model using the external data format.</p> <ul data-svelte-h="svelte-1x1hwlk"><li><code>false</code>: Do not use external data format</li> <li><code>true</code>: Use external data format with 1 chunk</li> <li><code>number</code>: Use external data format with the specified number of chunks</li></ul> <p data-svelte-h="svelte-1cbhk66"><em>Type:</em> <code>boolean</code> \| <code>number</code></p> <a id="module_utils/hub.PretrainedOptions"></a> <h3 class="relative group"><a id="pretrainedoptions" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#pretrainedoptions"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>PretrainedOptions</span></h3> <p data-svelte-h="svelte-1oi15lr">Options for loading a pretrained model.</p> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <ul data-svelte-h="svelte-1ivmxi2"><li><code>progress_callback</code> (<a href="./core#module_utils/core.ProgressCallback"><code>ProgressCallback</code></a>) <em>optional</em> — defaults to <code>null</code> — If specified, this function is called during model construction with progress updates.</li> <li><code>config</code> (<a href="../configs#module_configs.PretrainedConfig"><code>PretrainedConfig</code></a>) <em>optional</em> — defaults to <code>null</code> — Configuration to use for the model instead of an automatically loaded configuration. Configuration can be automatically loaded when:
	<ul><li>The model is provided by the library and loaded with the <em>model ID</em> string of a pretrained model.</li> <li>The model is loaded by supplying a local directory as <code>pretrained_model_name_or_path</code> and a configuration JSON file named <em>config.json</em> is found in the directory.</li></ul></li> <li><code>cache_dir</code> (<code>string</code>) <em>optional</em> — defaults to <code>null</code> — Path to a directory where downloaded model files should be cached if the standard cache should not be used.</li> <li><code>local_files_only</code> (<code>boolean</code>) <em>optional</em> — defaults to <code>false</code> — Whether to only look at local files (e.g., not try downloading the model).</li> <li><code>revision</code> (<code>string</code>) <em>optional</em> — defaults to <code>'main'</code> — The model revision to use. This can be a branch name, tag name, or commit ID.
	Because the Hub uses Git-based storage, <code>revision</code> can be any identifier accepted by Git. Ignored for local requests.</li></ul> <a id="module_utils/hub.ModelSpecificPretrainedOptions"></a> <h3 class="relative group"><a id="modelspecificpretrainedoptions" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#modelspecificpretrainedoptions"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>ModelSpecificPretrainedOptions</span></h3> <p data-svelte-h="svelte-1oi15lr">Options for loading a pretrained model.</p> <p data-svelte-h="svelte-drbxoe"><strong>Properties</strong></p> <ul data-svelte-h="svelte-1pwhu2e"><li><code>subfolder</code> (<code>string</code>) <em>optional</em> — defaults to <code>'onnx'</code> — In case the relevant files are located inside a subfolder of the model repo on huggingface.co,
	you can specify the folder name here.</li> <li><code>model_file_name</code> (<code>string</code>) <em>optional</em> — defaults to <code>null</code> — Override the base ONNX model file name, excluding dtype and <code>.onnx</code> suffixes. This is most useful for single-session models.</li> <li><code>device</code> (<a href="../transformers#module_transformers.DeviceType"><code>DeviceType</code></a> \| <code>Record</code><<code>string</code>, <a href="../transformers#module_transformers.DeviceType"><code>DeviceType</code></a>>) <em>optional</em> — defaults to <code>null</code> — The device to run the model on. If not specified, the device will be chosen from the environment settings.</li> <li><code>dtype</code> (<a href="../transformers#module_transformers.DataType"><code>DataType</code></a> \| <code>Record</code><<code>string</code>, <a href="../transformers#module_transformers.DataType"><code>DataType</code></a>>) <em>optional</em> — defaults to <code>null</code> — The data type to use for the model. If not specified, the data type will be chosen from the environment settings.</li> <li><code>use_external_data_format</code> (<a href="./hub#module_utils/hub.ExternalData"><code>ExternalData</code></a> \| <code>Record</code><<code>string</code>, <a href="./hub#module_utils/hub.ExternalData"><code>ExternalData</code></a>>) <em>optional</em> — defaults to <code>null</code> — Whether to load external data files. <code>null</code> uses the model configuration; <code>false</code> disables external data; <code>true</code> uses one chunk; a number selects the chunk count.</li> <li><code>session_options</code> (<code>InferenceSession.SessionOptions</code>) <em>optional</em> — defaults to <code>{}</code> — User-specified ONNX Runtime session options. Suitable defaults are filled in when omitted.</li></ul> <a id="module_utils/hub.PretrainedModelOptions"></a> <h3 class="relative group"><a id="pretrainedmodeloptions" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#pretrainedmodeloptions"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>PretrainedModelOptions</span></h3> <p data-svelte-h="svelte-1oi15lr">Options for loading a pretrained model.</p> <p data-svelte-h="svelte-pammmj"><em>Type:</em> <a href="./hub#module_utils/hub.PretrainedOptions"><code>PretrainedOptions</code></a> & <a href="./hub#module_utils/hub.ModelSpecificPretrainedOptions"><code>ModelSpecificPretrainedOptions</code></a></p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/transformers.js/blob/main/packages/transformers/docs/source/api/utils/hub.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_1t06csc = {
	assets: "/docs/transformers.js/pr_1665/en",
	base: "/docs/transformers.js/pr_1665/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/transformers.js/pr_1665/en/_app/immutable/entry/start.cb58eb6f.js"),
	import("/docs/transformers.js/pr_1665/en/_app/immutable/entry/app.9eafcf9d.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 18],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 18.1 kB
Xet hash:: a5363f16257b5293edfb324411d27391bb8b9f91d61f5b675c37ad41b0ad19bd

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.