Buckets:

hf-doc-build/doc / setfit /v1.1.2 /en /how_to /multilabel.html
rtrm's picture
download
raw
12.1 kB
<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Multilabel Text Classification&quot;,&quot;local&quot;:&quot;multilabel-text-classification&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Multilabel strategies&quot;,&quot;local&quot;:&quot;multilabel-strategies&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Initializing SetFit models with multilabel strategies&quot;,&quot;local&quot;:&quot;initializing-setfit-models-with-multilabel-strategies&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
<link href="/docs/setfit/v1.1.2/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/entry/start.b7a9b643.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/scheduler.c59d9fbb.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/singletons.ee757831.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/paths.54781efa.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/entry/app.17e9af47.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/index.a47918e3.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/nodes/0.400211f3.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/each.e59479a4.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/nodes/11.863bd568.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/Tip.3fcf4aa4.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/CodeBlock.f26209eb.js">
<link rel="modulepreload" href="/docs/setfit/v1.1.2/en/_app/immutable/chunks/index.0513ac52.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Multilabel Text Classification&quot;,&quot;local&quot;:&quot;multilabel-text-classification&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Multilabel strategies&quot;,&quot;local&quot;:&quot;multilabel-strategies&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Initializing SetFit models with multilabel strategies&quot;,&quot;local&quot;:&quot;initializing-setfit-models-with-multilabel-strategies&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="multilabel-text-classification" 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="#multilabel-text-classification"><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>Multilabel Text Classification</span></h1> <p data-svelte-h="svelte-1suhalr">SetFit supports multilabel classification, allowing multiple labels to be assigned to each instance.</p> <div class="course-tip bg-gradient-to-br dark:bg-gradient-to-r before:border-green-500 dark:before:border-green-800 from-green-50 dark:from-gray-900 to-white dark:to-gray-950 border border-green-50 text-green-700 dark:text-gray-400"><p data-svelte-h="svelte-oj451i">Unless each instance must be assigned multiple outputs, you frequently do not need to specify a multi target strategy.</p></div> <p data-svelte-h="svelte-13p5ezl">This guide will show you how to train and use multilabel SetFit models.</p> <h2 class="relative group"><a id="multilabel-strategies" 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="#multilabel-strategies"><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>Multilabel strategies</span></h2> <p data-svelte-h="svelte-zhilh4">SetFit will initialise a multilabel classification head from <code>sklearn</code> - the following options are available for <code>multi_target_strategy</code>:</p> <ul data-svelte-h="svelte-h2knuu"><li><code>&quot;one-vs-rest&quot;</code>: uses a <a href="https://scikit-learn.org/stable/modules/generated/sklearn.multiclass.OneVsRestClassifier.html" rel="nofollow"><code>OneVsRestClassifier</code></a> head.</li> <li><code>&quot;multi-output&quot;</code>: uses a <a href="https://scikit-learn.org/stable/modules/generated/sklearn.multioutput.MultiOutputClassifier.html" rel="nofollow"><code>MultiOutputClassifier</code></a> head.</li> <li><code>&quot;classifier-chain&quot;</code>: uses a <a href="https://scikit-learn.org/stable/modules/generated/sklearn.multioutput.ClassifierChain.html" rel="nofollow"><code>ClassifierChain</code></a> head.</li></ul> <p data-svelte-h="svelte-1cgmuwl">See the <a href="https://scikit-learn.org/stable/modules/multiclass.html#multiclass-classification" rel="nofollow">scikit-learn documentation for multiclass and multioutput classification</a> for more details.</p> <h2 class="relative group"><a id="initializing-setfit-models-with-multilabel-strategies" 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="#initializing-setfit-models-with-multilabel-strategies"><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>Initializing SetFit models with multilabel strategies</span></h2> <p data-svelte-h="svelte-59k6ip">Using the default LogisticRegression head, we can apply multi target strategies like so:</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> setfit <span class="hljs-keyword">import</span> SetFitModel
model = SetFitModel.from_pretrained(
model_id, <span class="hljs-comment"># e.g. &quot;BAAI/bge-small-en-v1.5&quot;</span>
multi_target_strategy=<span class="hljs-string">&quot;multi-output&quot;</span>,
)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-8iwzib">With a differentiable head it looks like so:</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> setfit <span class="hljs-keyword">import</span> SetFitModel
model = SetFitModel.from_pretrained(
model_id, <span class="hljs-comment"># e.g. &quot;BAAI/bge-small-en-v1.5&quot;</span>
multi_target_strategy=<span class="hljs-string">&quot;one-vs-rest&quot;</span>
use_differentiable_head=<span class="hljs-literal">True</span>,
head_params={<span class="hljs-string">&quot;out_features&quot;</span>: num_classes},
)<!-- HTML_TAG_END --></pre></div> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/setfit/blob/main/docs/source/en/how_to/multilabel.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1">&lt;</span> <span data-svelte-h="svelte-x0xyl0">&gt;</span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p>
<script>
{
__sveltekit_1u7xim2 = {
assets: "/docs/setfit/v1.1.2/en",
base: "/docs/setfit/v1.1.2/en",
env: {}
};
const element = document.currentScript.parentElement;
const data = [null,null];
Promise.all([
import("/docs/setfit/v1.1.2/en/_app/immutable/entry/start.b7a9b643.js"),
import("/docs/setfit/v1.1.2/en/_app/immutable/entry/app.17e9af47.js")
]).then(([kit, app]) => {
kit.start(app, element, {
node_ids: [0, 11],
data,
form: null,
error: null
});
});
}
</script>

Xet Storage Details

Size:
12.1 kB
·
Xet hash:
e69479a68638ca4b99385cb21168cb9dc5c907b157416650e3628d5aec6df6dc

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