Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / optimum-executorch /pr_71 /en /guides /contribute.html

rtrm

about 2 months ago

download

raw

17 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Adding support for an unsupported architecture","local":"adding-support-for-an-unsupported-architecture","sections":[{"title":"Exporting a New Model","local":"exporting-a-new-model","sections":[{"title":"Step 1: Export and Test the Model","local":"step-1-export-and-test-the-model","sections":[],"depth":3},{"title":"Step 2: Handle Export Failures","local":"step-2-handle-export-failures","sections":[],"depth":3}],"depth":2},{"title":"Adding New Recipes or Tasks","local":"adding-new-recipes-or-tasks","sections":[{"title":"Registering a New Recipe","local":"registering-a-new-recipe","sections":[],"depth":3},{"title":"Registering a Task","local":"registering-a-task","sections":[],"depth":3}],"depth":2}],"depth":1}">
	<link href="/docs/optimum.executorch/pr_71/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/entry/start.bc332b8a.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/scheduler.b108d059.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/singletons.1ce2053b.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/paths.7613eb12.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/entry/app.102c0a63.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/index.008de539.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/nodes/0.e8bcc7f9.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/nodes/2.55214465.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/CodeBlock.7b00c886.js">
	<link rel="modulepreload" href="/docs/optimum.executorch/pr_71/en/_app/immutable/chunks/getInferenceSnippets.51e5e199.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Adding support for an unsupported architecture","local":"adding-support-for-an-unsupported-architecture","sections":[{"title":"Exporting a New Model","local":"exporting-a-new-model","sections":[{"title":"Step 1: Export and Test the Model","local":"step-1-export-and-test-the-model","sections":[],"depth":3},{"title":"Step 2: Handle Export Failures","local":"step-2-handle-export-failures","sections":[],"depth":3}],"depth":2},{"title":"Adding New Recipes or Tasks","local":"adding-new-recipes-or-tasks","sections":[{"title":"Registering a New Recipe","local":"registering-a-new-recipe","sections":[],"depth":3},{"title":"Registering a Task","local":"registering-a-task","sections":[],"depth":3}],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="adding-support-for-an-unsupported-architecture" 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="#adding-support-for-an-unsupported-architecture"><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>Adding support for an unsupported architecture</span></h1> <p data-svelte-h="svelte-9dce63">We welcome contributions to extend the functionality of ExecuTorch export. This guide provides high-level instructions for contributors who want to:</p> <ol data-svelte-h="svelte-12e49tb"><li>Export a new model that is not currently supported.</li> <li>Add new recipes or support a new task for export.</li></ol> <hr> <h2 class="relative group"><a id="exporting-a-new-model" 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="#exporting-a-new-model"><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>Exporting a New Model</span></h2> <p data-svelte-h="svelte-39f5p3">If you want to export a model that is not already supported by the library, follow these steps:</p> <h3 class="relative group"><a id="step-1-export-and-test-the-model" 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="#step-1-export-and-test-the-model"><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>Step 1: Export and Test the Model</span></h3> <ol><li data-svelte-h="svelte-1ecwca1">Attempt to export and lower the model using an existing task and recipe. On success, it will store the exported model in a <code>.pte</code> file.</li> <li>Add a test case for the model in the appropriate test suite.<ul><li>For example, you can make sure tests pass for the new <code data-svelte-h="svelte-p2jkx5">my_new_model</code> by running:
	<div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" 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> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START -->pytest tests/executorch/export/test_*.py -k <span class="hljs-string">"test_my_new_model"</span> <span class="hljs-comment"># doctest: +SKIP</span>
	pytest tests/executorch/runtime/test_*.py -k <span class="hljs-string">"test_my_new_model"</span> <span class="hljs-comment"># doctest: +SKIP</span><!-- HTML_TAG_END --></pre></div></li></ul></li></ol> <h3 class="relative group"><a id="step-2-handle-export-failures" 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="#step-2-handle-export-failures"><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>Step 2: Handle Export Failures</span></h3> <ol data-svelte-h="svelte-630l9r"><li>If the export fails in Step 1, report the issue by opening a GitHub issue.</li> <li>If the issue requires changes to the model’s architecture or its Hugging Face implementation, these modifications may be made upstream in the Hugging Face Transformers library.</li></ol> <hr> <h2 class="relative group"><a id="adding-new-recipes-or-tasks" 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="#adding-new-recipes-or-tasks"><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>Adding New Recipes or Tasks</span></h2> <p data-svelte-h="svelte-126pkge">To extend ExecuTorch with new recipes or tasks, follow these guidelines:</p> <h3 class="relative group"><a id="registering-a-new-recipe" 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="#registering-a-new-recipe"><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>Registering a New Recipe</span></h3> <p data-svelte-h="svelte-1awgeeh">You can add a custom recipe to define specific optimizations or configurations for exporting models. Below is an example:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" 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> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-keyword">from</span> exporters.executorch <span class="hljs-keyword">import</span> register_recipe

	<span class="hljs-meta">@register_recipe(<span class="hljs-params"><span class="hljs-string">"my_custom_recipe"</span></span>)</span>
	<span class="hljs-keyword">def</span> <span class="hljs-title function_">export_with_custom_recipe</span>(<span class="hljs-params">model, config, args, *kwargs</span>):
	<span class="hljs-comment"># Example: Apply a custom quantization</span><!-- HTML_TAG_END --></pre></div> <h3 class="relative group"><a id="registering-a-task" 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="#registering-a-task"><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>Registering a Task</span></h3> <p data-svelte-h="svelte-tpz6o6">The task registration process is same as adding a recipe. Besides that you may need to implement a new <code>ExecuTorchModelForXXX</code> class.</p> <p></p>

	<script>
	{
	__sveltekit_xd0x4o = {
	assets: "/docs/optimum.executorch/pr_71/en",
	base: "/docs/optimum.executorch/pr_71/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/optimum.executorch/pr_71/en/_app/immutable/entry/start.bc332b8a.js"),
	import("/docs/optimum.executorch/pr_71/en/_app/immutable/entry/app.102c0a63.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 2],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 17 kB
Xet hash:: 3fe2e018958d732b6135e85ba5d69f7bf53c606b5ac60f2771d5f60dfd9e1b36

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