Buckets:

hf-doc-build/doc-dev / autotrain /pr_749 /en /extractive_qa.html
rtrm's picture
download
raw
12 kB
<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Extractive Question Answering&quot;,&quot;local&quot;:&quot;extractive-question-answering&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Preparing your data&quot;,&quot;local&quot;:&quot;preparing-your-data&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
<link href="/docs/autotrain/pr_749/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/scheduler.0219f8bd.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/singletons.74a96c49.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/paths.5815e531.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/index.f61edf3b.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/0.3ba41ccf.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/8.75649b4e.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/CodeBlock.38e566ae.js">
<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/EditOnGithub.48fa589f.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Extractive Question Answering&quot;,&quot;local&quot;:&quot;extractive-question-answering&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Preparing your data&quot;,&quot;local&quot;:&quot;preparing-your-data&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="extractive-question-answering" 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="#extractive-question-answering"><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>Extractive Question Answering</span></h1> <p data-svelte-h="svelte-149tvei">Extractive Question Answering is a task in which a model is trained to extract the answer to a question from a given context.
The model is trained to predict the start and end positions of the answer span within the context.
This task is commonly used in question-answering systems to extract relevant information from a large corpus of text.</p> <h2 class="relative group"><a id="preparing-your-data" 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="#preparing-your-data"><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>Preparing your data</span></h2> <p data-svelte-h="svelte-kihe0r">To train an Extractive Question Answering model, you need a dataset that contains the following columns:</p> <ul data-svelte-h="svelte-bguxzv"><li><code>text</code>: The context or passage from which the answer is to be extracted.</li> <li><code>question</code>: The question for which the answer is to be extracted.</li> <li><code>answer</code>: The start position of the answer span in the context.</li></ul> <p data-svelte-h="svelte-1qo5dyf">Here is an example of how your dataset should look:</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-comment">&quot;context&quot;</span>:<span class="hljs-comment">&quot;Architecturally, the school has a Catholic character. Atop the Main Building&#x27;s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend \&quot;</span><span class="hljs-type">Venite</span> <span class="hljs-type">Ad</span> <span class="hljs-type">Me</span> <span class="hljs-type">Omnes</span>\<span class="hljs-comment">&quot;. Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.&quot;</span>,<span class="hljs-comment">&quot;question&quot;</span>:<span class="hljs-comment">&quot;To whom did the Virgin Mary allegedly appear in 1858 in Lourdes France?&quot;</span>,<span class="hljs-comment">&quot;answers&quot;</span>:{<span class="hljs-comment">&quot;text&quot;</span>:[<span class="hljs-comment">&quot;Saint Bernadette Soubirous&quot;</span>],<span class="hljs-comment">&quot;answer_start&quot;</span>:[<span class="hljs-number">515</span>]}}
{<span class="hljs-comment">&quot;context&quot;</span>:<span class="hljs-comment">&quot;Architecturally, the school has a Catholic character. Atop the Main Building&#x27;s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend \&quot;</span><span class="hljs-type">Venite</span> <span class="hljs-type">Ad</span> <span class="hljs-type">Me</span> <span class="hljs-type">Omnes</span>\<span class="hljs-comment">&quot;. Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.&quot;</span>,<span class="hljs-comment">&quot;question&quot;</span>:<span class="hljs-comment">&quot;What is in front of the Notre Dame Main Building?&quot;</span>,<span class="hljs-comment">&quot;answers&quot;</span>:{<span class="hljs-comment">&quot;text&quot;</span>:[<span class="hljs-comment">&quot;a copper statue of Christ&quot;</span>],<span class="hljs-comment">&quot;answer_start&quot;</span>:[<span class="hljs-number">188</span>]}}
{<span class="hljs-comment">&quot;context&quot;</span>:<span class="hljs-comment">&quot;Architecturally, the school has a Catholic character. Atop the Main Building&#x27;s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend \&quot;</span><span class="hljs-type">Venite</span> <span class="hljs-type">Ad</span> <span class="hljs-type">Me</span> <span class="hljs-type">Omnes</span>\<span class="hljs-comment">&quot;. Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.&quot;</span>,<span class="hljs-comment">&quot;question&quot;</span>:<span class="hljs-comment">&quot;The Basilica of the Sacred heart at Notre Dame is beside to which structure?&quot;</span>,<span class="hljs-comment">&quot;answers&quot;</span>:{<span class="hljs-comment">&quot;text&quot;</span>:[<span class="hljs-comment">&quot;the Main Building&quot;</span>],<span class="hljs-comment">&quot;answer_start&quot;</span>:[<span class="hljs-number">279</span>]}}<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-ay5x2s">Note: the preferred format for question answering is JSONL, if you want to use CSV, the <code>answer</code> column should be stringified JSON with the keys <code>text</code> and <code>answer_start</code>.</p> <p data-svelte-h="svelte-gg43qg">Example dataset from Hugging Face Hub: <a href="https://huggingface.co/datasets/lhoestq/squad" rel="nofollow">lhoestq/squad</a></p> <p data-svelte-h="svelte-1iv0l1d">P.S. You can use both squad and squad v2 data format with correct column mappings.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/autotrain-advanced/blob/main/docs/source/extractive_qa.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_ewvlbq = {
assets: "/docs/autotrain/pr_749/en",
base: "/docs/autotrain/pr_749/en",
env: {}
};
const element = document.currentScript.parentElement;
const data = [null,null];
Promise.all([
import("/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js"),
import("/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js")
]).then(([kit, app]) => {
kit.start(app, element, {
node_ids: [0, 8],
data,
form: null,
error: null
});
});
}
</script>

Xet Storage Details

Size:
12 kB
·
Xet hash:
aded8697d05a94b5966c48c438f1c62eae19fe6431984c0338969d69781287e8

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