docs/text/qa/qa_finetuner.html

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>ktrain.text.qa.qa_finetuner API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>ktrain.text.qa.qa_finetuner</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import warnings

import pandas as pd
import tensorflow as tf


def convert_to_dataset(list_of_dicts):
    try:
        from datasets import Dataset, load_dataset
    except ImportError:
        raise ImportError(
            &#34;The datasets package is required for fine-tuning QA models: pip install datasets&#34;
        )

    new_list = []
    for d in list_of_dicts:
        if &#34;question&#34; not in d or &#34;context&#34; not in d or &#34;answers&#34; not in d:
            raise ValueError(
                &#39;All dictionaries in list must have the following keys: &#34;question&#34;, &#34;context&#34;, &#34;answers&#34;&#39;
            )
        q = d[&#34;question&#34;].strip()
        c = d[&#34;context&#34;].strip()
        a = d[&#34;answers&#34;].strip() if isinstance(d[&#34;answers&#34;], str) else d[&#34;answers&#34;]
        if a is None:
            answers = {&#34;text&#34;: [], &#34;answer_start&#34;: []}
        elif isinstance(a, dict):
            ans_start = a[&#34;answer_start&#34;]
            ans_text = a[&#34;text&#34;]
            answers = {&#34;text&#34;: ans_text, &#34;answer_start&#34;: ans_start}
        elif isinstance(a, str):
            ans_start = c.index(a)
            if ans_start &lt; 0:
                raise ValueError(&#34;Could not locate answer in context: %s&#34; % (d))
            ans_start = [ans_start]
            answers = {&#34;text&#34;: [a], &#34;answer_start&#34;: ans_start}
        else:
            raise ValueError(
                &#39;Value for &#34;answers&#34; key must be a string, dictionary, or None&#39;
            )
        new_d = {&#34;question&#34;: q, &#34;context&#34;: c, &#34;answers&#34;: answers}
        new_list.append(new_d)
    dataset = Dataset.from_pandas(pd.DataFrame(new_list))

    # uncomment to test with squad sample
    # datasets = load_dataset(&#39;squad&#39;)
    # td = datasets[&#39;train&#39;]
    # td = Dataset.from_pandas(td.to_pandas().head(100))
    # return td
    return dataset


def convert_dataset_for_tensorflow(
    dataset,
    batch_size,
    dataset_mode=&#34;variable_batch&#34;,
    shuffle=True,
    drop_remainder=True,
):
    &#34;&#34;&#34;Converts a Hugging Face dataset to a Tensorflow Dataset. The dataset_mode controls whether we pad all batches
    to the maximum sequence length, or whether we only pad to the maximum length within that batch. The former
    is most useful when training on TPU, as a new graph compilation is required for each sequence length.
    &#34;&#34;&#34;
    try:
        from datasets import Dataset, load_dataset
    except ImportError:
        raise ImportError(
            &#34;The datasets package is required for fine-tuning QA models: pip install datasets&#34;
        )

    def densify_ragged_batch(features, label=None):
        features = {
            feature: (
                ragged_tensor.to_tensor(shape=batch_shape[feature])
                if feature in tensor_keys
                else ragged_tensor
            )
            for feature, ragged_tensor in features.items()
        }
        if label is None:
            return features
        else:
            return features, label

    tensor_keys = [&#34;attention_mask&#34;, &#34;input_ids&#34;]
    label_keys = [&#34;start_positions&#34;, &#34;end_positions&#34;]
    if dataset_mode == &#34;variable_batch&#34;:
        batch_shape = {key: None for key in tensor_keys}
        data = {key: tf.ragged.constant(dataset[key]) for key in tensor_keys}
    elif dataset_mode == &#34;constant_batch&#34;:
        data = {key: tf.ragged.constant(dataset[key]) for key in tensor_keys}
        batch_shape = {
            key: tf.concat(([batch_size], ragged_tensor.bounding_shape()[1:]), axis=0)
            for key, ragged_tensor in data.items()
        }
    else:
        raise ValueError(&#34;Unknown dataset mode!&#34;)

    if all([key in dataset.features for key in label_keys]):
        for key in label_keys:
            data[key] = tf.convert_to_tensor(dataset[key])
        dummy_labels = tf.zeros_like(dataset[key])
        tf_dataset = tf.data.Dataset.from_tensor_slices((data, dummy_labels))
    else:
        tf_dataset = tf.data.Dataset.from_tensor_slices(data)
    if shuffle:
        tf_dataset = tf_dataset.shuffle(buffer_size=len(dataset))
    tf_dataset = tf_dataset.batch(
        batch_size=batch_size, drop_remainder=drop_remainder
    ).map(densify_ragged_batch)
    return tf_dataset


class QAFineTuner:
    def __init__(self, model, tokenizer):
        self.model = model
        self.tokenizer = tokenizer

    def finetune(
        self, data, epochs=3, learning_rate=2e-5, batch_size=8, max_seq_length=512
    ):
        &#34;&#34;&#34;
        ```
        Finetune a QA model.

        Args:
          data(list): list of dictionaries of the form:
                      [{&#39;question&#39;: &#39;What is ktrain?&#39;
                       &#39;context&#39;: &#39;ktrain is a low-code library for augmented machine learning.&#39;
                       &#39;answer&#39;: &#39;ktrain&#39;}]
          epochs(int): number of epochs.  Default:3
          learning_rate(float): learning rate.  Default: 2e-5
        Returns:
          fine-tuned model (i.e., QAFineTuner.model)
        ```
        &#34;&#34;&#34;
        if self.model.name_or_path.startswith(&#34;bert-large&#34;):
            warnings.warn(
                &#34;You are fine-tuning a bert-large-* model, which requires lots of memory.  &#34;
                + &#34;If you get a memory error, switch to distilbert-base-cased-distilled-squad.&#34;
            )
        if batch_size &gt; len(data):
            batch_size = len(data)

        model = self.model
        tokenizer = self.tokenizer
        question_column_name = &#34;question&#34;
        context_column_name = &#34;context&#34;
        answer_column_name = &#34;answers&#34;

        # Padding side determines if we do (question|context) or (context|question).
        pad_on_right = tokenizer.padding_side == &#34;right&#34;

        # Training preprocessing
        def prepare_train_features(examples):
            # Some of the questions have lots of whitespace on the left, which is not useful and will make the
            # truncation of the context fail (the tokenized question will take a lots of space). So we remove that
            # left whitespace
            examples[question_column_name] = [
                q.lstrip() for q in examples[question_column_name]
            ]

            # Tokenize our examples with truncation and maybe padding, but keep the overflows using a stride. This results
            # in one example possible giving several features when a context is long, each of those features having a
            # context that overlaps a bit the context of the previous feature.
            tokenized_examples = tokenizer(
                examples[question_column_name if pad_on_right else context_column_name],
                examples[context_column_name if pad_on_right else question_column_name],
                truncation=&#34;only_second&#34; if pad_on_right else &#34;only_first&#34;,
                max_length=max_seq_length,
                stride=128,
                return_overflowing_tokens=True,
                return_offsets_mapping=True,
                # padding=&#34;max_length&#34; if data_args.pad_to_max_length else False,
                padding=&#34;max_length&#34;,
            )

            # Since one example might give us several features if it has a long context, we need a map from a feature to
            # its corresponding example. This key gives us just that.
            sample_mapping = tokenized_examples.pop(&#34;overflow_to_sample_mapping&#34;)
            # The offset mappings will give us a map from token to character position in the original context. This will
            # help us compute the start_positions and end_positions.
            offset_mapping = tokenized_examples.pop(&#34;offset_mapping&#34;)

            # Let&#39;s label those examples!
            tokenized_examples[&#34;start_positions&#34;] = []
            tokenized_examples[&#34;end_positions&#34;] = []

            for i, offsets in enumerate(offset_mapping):
                # We will label impossible answers with the index of the CLS token.
                input_ids = tokenized_examples[&#34;input_ids&#34;][i]
                cls_index = input_ids.index(tokenizer.cls_token_id)

                # Grab the sequence corresponding to that example (to know what is the context and what is the question).
                sequence_ids = tokenized_examples.sequence_ids(i)

                # One example can give several spans, this is the index of the example containing this span of text.
                sample_index = sample_mapping[i]
                answers = examples[answer_column_name][sample_index]
                # If no answers are given, set the cls_index as answer.
                if len(answers[&#34;answer_start&#34;]) == 0:
                    tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                    tokenized_examples[&#34;end_positions&#34;].append(cls_index)
                else:
                    # Start/end character index of the answer in the text.
                    start_char = answers[&#34;answer_start&#34;][0]
                    end_char = start_char + len(answers[&#34;text&#34;][0])

                    # Start token index of the current span in the text.
                    token_start_index = 0
                    while sequence_ids[token_start_index] != (1 if pad_on_right else 0):
                        token_start_index += 1

                    # End token index of the current span in the text.
                    token_end_index = len(input_ids) - 1
                    while sequence_ids[token_end_index] != (1 if pad_on_right else 0):
                        token_end_index -= 1

                    # Detect if the answer is out of the span (in which case this feature is labeled with the CLS index).
                    if not (
                        offsets[token_start_index][0] &lt;= start_char
                        and offsets[token_end_index][1] &gt;= end_char
                    ):
                        tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                        tokenized_examples[&#34;end_positions&#34;].append(cls_index)
                    else:
                        # Otherwise move the token_start_index and token_end_index to the two ends of the answer.
                        # Note: we could go after the last offset if the answer is the last word (edge case).
                        while (
                            token_start_index &lt; len(offsets)
                            and offsets[token_start_index][0] &lt;= start_char
                        ):
                            token_start_index += 1
                        tokenized_examples[&#34;start_positions&#34;].append(
                            token_start_index - 1
                        )
                        while offsets[token_end_index][1] &gt;= end_char:
                            token_end_index -= 1
                        tokenized_examples[&#34;end_positions&#34;].append(token_end_index + 1)

            return tokenized_examples

        dataset = convert_to_dataset(data)
        print(dataset)
        print(dataset[0])

        train_dataset = dataset.map(
            prepare_train_features,
            batched=True,
            num_proc=1,
        )
        optimizer = tf.keras.optimizers.Adam(learning_rate=learning_rate)

        def dummy_loss(y_true, y_pred):
            return tf.reduce_mean(y_pred)

        losses = {&#34;loss&#34;: dummy_loss}
        model.compile(optimizer=optimizer, loss=losses)

        training_dataset = convert_dataset_for_tensorflow(
            train_dataset,
            batch_size=batch_size,
            dataset_mode=&#34;variable_batch&#34;,
            drop_remainder=True,
            shuffle=True,
        )
        model.fit(training_dataset, epochs=int(epochs))</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="ktrain.text.qa.qa_finetuner.convert_dataset_for_tensorflow"><code class="name flex">
<span>def <span class="ident">convert_dataset_for_tensorflow</span></span>(<span>dataset, batch_size, dataset_mode='variable_batch', shuffle=True, drop_remainder=True)</span>
</code></dt>
<dd>
<div class="desc"><p>Converts a Hugging Face dataset to a Tensorflow Dataset. The dataset_mode controls whether we pad all batches
to the maximum sequence length, or whether we only pad to the maximum length within that batch. The former
is most useful when training on TPU, as a new graph compilation is required for each sequence length.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def convert_dataset_for_tensorflow(
    dataset,
    batch_size,
    dataset_mode=&#34;variable_batch&#34;,
    shuffle=True,
    drop_remainder=True,
):
    &#34;&#34;&#34;Converts a Hugging Face dataset to a Tensorflow Dataset. The dataset_mode controls whether we pad all batches
    to the maximum sequence length, or whether we only pad to the maximum length within that batch. The former
    is most useful when training on TPU, as a new graph compilation is required for each sequence length.
    &#34;&#34;&#34;
    try:
        from datasets import Dataset, load_dataset
    except ImportError:
        raise ImportError(
            &#34;The datasets package is required for fine-tuning QA models: pip install datasets&#34;
        )

    def densify_ragged_batch(features, label=None):
        features = {
            feature: (
                ragged_tensor.to_tensor(shape=batch_shape[feature])
                if feature in tensor_keys
                else ragged_tensor
            )
            for feature, ragged_tensor in features.items()
        }
        if label is None:
            return features
        else:
            return features, label

    tensor_keys = [&#34;attention_mask&#34;, &#34;input_ids&#34;]
    label_keys = [&#34;start_positions&#34;, &#34;end_positions&#34;]
    if dataset_mode == &#34;variable_batch&#34;:
        batch_shape = {key: None for key in tensor_keys}
        data = {key: tf.ragged.constant(dataset[key]) for key in tensor_keys}
    elif dataset_mode == &#34;constant_batch&#34;:
        data = {key: tf.ragged.constant(dataset[key]) for key in tensor_keys}
        batch_shape = {
            key: tf.concat(([batch_size], ragged_tensor.bounding_shape()[1:]), axis=0)
            for key, ragged_tensor in data.items()
        }
    else:
        raise ValueError(&#34;Unknown dataset mode!&#34;)

    if all([key in dataset.features for key in label_keys]):
        for key in label_keys:
            data[key] = tf.convert_to_tensor(dataset[key])
        dummy_labels = tf.zeros_like(dataset[key])
        tf_dataset = tf.data.Dataset.from_tensor_slices((data, dummy_labels))
    else:
        tf_dataset = tf.data.Dataset.from_tensor_slices(data)
    if shuffle:
        tf_dataset = tf_dataset.shuffle(buffer_size=len(dataset))
    tf_dataset = tf_dataset.batch(
        batch_size=batch_size, drop_remainder=drop_remainder
    ).map(densify_ragged_batch)
    return tf_dataset</code></pre>
</details>
</dd>
<dt id="ktrain.text.qa.qa_finetuner.convert_to_dataset"><code class="name flex">
<span>def <span class="ident">convert_to_dataset</span></span>(<span>list_of_dicts)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def convert_to_dataset(list_of_dicts):
    try:
        from datasets import Dataset, load_dataset
    except ImportError:
        raise ImportError(
            &#34;The datasets package is required for fine-tuning QA models: pip install datasets&#34;
        )

    new_list = []
    for d in list_of_dicts:
        if &#34;question&#34; not in d or &#34;context&#34; not in d or &#34;answers&#34; not in d:
            raise ValueError(
                &#39;All dictionaries in list must have the following keys: &#34;question&#34;, &#34;context&#34;, &#34;answers&#34;&#39;
            )
        q = d[&#34;question&#34;].strip()
        c = d[&#34;context&#34;].strip()
        a = d[&#34;answers&#34;].strip() if isinstance(d[&#34;answers&#34;], str) else d[&#34;answers&#34;]
        if a is None:
            answers = {&#34;text&#34;: [], &#34;answer_start&#34;: []}
        elif isinstance(a, dict):
            ans_start = a[&#34;answer_start&#34;]
            ans_text = a[&#34;text&#34;]
            answers = {&#34;text&#34;: ans_text, &#34;answer_start&#34;: ans_start}
        elif isinstance(a, str):
            ans_start = c.index(a)
            if ans_start &lt; 0:
                raise ValueError(&#34;Could not locate answer in context: %s&#34; % (d))
            ans_start = [ans_start]
            answers = {&#34;text&#34;: [a], &#34;answer_start&#34;: ans_start}
        else:
            raise ValueError(
                &#39;Value for &#34;answers&#34; key must be a string, dictionary, or None&#39;
            )
        new_d = {&#34;question&#34;: q, &#34;context&#34;: c, &#34;answers&#34;: answers}
        new_list.append(new_d)
    dataset = Dataset.from_pandas(pd.DataFrame(new_list))

    # uncomment to test with squad sample
    # datasets = load_dataset(&#39;squad&#39;)
    # td = datasets[&#39;train&#39;]
    # td = Dataset.from_pandas(td.to_pandas().head(100))
    # return td
    return dataset</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="ktrain.text.qa.qa_finetuner.QAFineTuner"><code class="flex name class">
<span>class <span class="ident">QAFineTuner</span></span>
<span>(</span><span>model, tokenizer)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class QAFineTuner:
    def __init__(self, model, tokenizer):
        self.model = model
        self.tokenizer = tokenizer

    def finetune(
        self, data, epochs=3, learning_rate=2e-5, batch_size=8, max_seq_length=512
    ):
        &#34;&#34;&#34;
        ```
        Finetune a QA model.

        Args:
          data(list): list of dictionaries of the form:
                      [{&#39;question&#39;: &#39;What is ktrain?&#39;
                       &#39;context&#39;: &#39;ktrain is a low-code library for augmented machine learning.&#39;
                       &#39;answer&#39;: &#39;ktrain&#39;}]
          epochs(int): number of epochs.  Default:3
          learning_rate(float): learning rate.  Default: 2e-5
        Returns:
          fine-tuned model (i.e., QAFineTuner.model)
        ```
        &#34;&#34;&#34;
        if self.model.name_or_path.startswith(&#34;bert-large&#34;):
            warnings.warn(
                &#34;You are fine-tuning a bert-large-* model, which requires lots of memory.  &#34;
                + &#34;If you get a memory error, switch to distilbert-base-cased-distilled-squad.&#34;
            )
        if batch_size &gt; len(data):
            batch_size = len(data)

        model = self.model
        tokenizer = self.tokenizer
        question_column_name = &#34;question&#34;
        context_column_name = &#34;context&#34;
        answer_column_name = &#34;answers&#34;

        # Padding side determines if we do (question|context) or (context|question).
        pad_on_right = tokenizer.padding_side == &#34;right&#34;

        # Training preprocessing
        def prepare_train_features(examples):
            # Some of the questions have lots of whitespace on the left, which is not useful and will make the
            # truncation of the context fail (the tokenized question will take a lots of space). So we remove that
            # left whitespace
            examples[question_column_name] = [
                q.lstrip() for q in examples[question_column_name]
            ]

            # Tokenize our examples with truncation and maybe padding, but keep the overflows using a stride. This results
            # in one example possible giving several features when a context is long, each of those features having a
            # context that overlaps a bit the context of the previous feature.
            tokenized_examples = tokenizer(
                examples[question_column_name if pad_on_right else context_column_name],
                examples[context_column_name if pad_on_right else question_column_name],
                truncation=&#34;only_second&#34; if pad_on_right else &#34;only_first&#34;,
                max_length=max_seq_length,
                stride=128,
                return_overflowing_tokens=True,
                return_offsets_mapping=True,
                # padding=&#34;max_length&#34; if data_args.pad_to_max_length else False,
                padding=&#34;max_length&#34;,
            )

            # Since one example might give us several features if it has a long context, we need a map from a feature to
            # its corresponding example. This key gives us just that.
            sample_mapping = tokenized_examples.pop(&#34;overflow_to_sample_mapping&#34;)
            # The offset mappings will give us a map from token to character position in the original context. This will
            # help us compute the start_positions and end_positions.
            offset_mapping = tokenized_examples.pop(&#34;offset_mapping&#34;)

            # Let&#39;s label those examples!
            tokenized_examples[&#34;start_positions&#34;] = []
            tokenized_examples[&#34;end_positions&#34;] = []

            for i, offsets in enumerate(offset_mapping):
                # We will label impossible answers with the index of the CLS token.
                input_ids = tokenized_examples[&#34;input_ids&#34;][i]
                cls_index = input_ids.index(tokenizer.cls_token_id)

                # Grab the sequence corresponding to that example (to know what is the context and what is the question).
                sequence_ids = tokenized_examples.sequence_ids(i)

                # One example can give several spans, this is the index of the example containing this span of text.
                sample_index = sample_mapping[i]
                answers = examples[answer_column_name][sample_index]
                # If no answers are given, set the cls_index as answer.
                if len(answers[&#34;answer_start&#34;]) == 0:
                    tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                    tokenized_examples[&#34;end_positions&#34;].append(cls_index)
                else:
                    # Start/end character index of the answer in the text.
                    start_char = answers[&#34;answer_start&#34;][0]
                    end_char = start_char + len(answers[&#34;text&#34;][0])

                    # Start token index of the current span in the text.
                    token_start_index = 0
                    while sequence_ids[token_start_index] != (1 if pad_on_right else 0):
                        token_start_index += 1

                    # End token index of the current span in the text.
                    token_end_index = len(input_ids) - 1
                    while sequence_ids[token_end_index] != (1 if pad_on_right else 0):
                        token_end_index -= 1

                    # Detect if the answer is out of the span (in which case this feature is labeled with the CLS index).
                    if not (
                        offsets[token_start_index][0] &lt;= start_char
                        and offsets[token_end_index][1] &gt;= end_char
                    ):
                        tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                        tokenized_examples[&#34;end_positions&#34;].append(cls_index)
                    else:
                        # Otherwise move the token_start_index and token_end_index to the two ends of the answer.
                        # Note: we could go after the last offset if the answer is the last word (edge case).
                        while (
                            token_start_index &lt; len(offsets)
                            and offsets[token_start_index][0] &lt;= start_char
                        ):
                            token_start_index += 1
                        tokenized_examples[&#34;start_positions&#34;].append(
                            token_start_index - 1
                        )
                        while offsets[token_end_index][1] &gt;= end_char:
                            token_end_index -= 1
                        tokenized_examples[&#34;end_positions&#34;].append(token_end_index + 1)

            return tokenized_examples

        dataset = convert_to_dataset(data)
        print(dataset)
        print(dataset[0])

        train_dataset = dataset.map(
            prepare_train_features,
            batched=True,
            num_proc=1,
        )
        optimizer = tf.keras.optimizers.Adam(learning_rate=learning_rate)

        def dummy_loss(y_true, y_pred):
            return tf.reduce_mean(y_pred)

        losses = {&#34;loss&#34;: dummy_loss}
        model.compile(optimizer=optimizer, loss=losses)

        training_dataset = convert_dataset_for_tensorflow(
            train_dataset,
            batch_size=batch_size,
            dataset_mode=&#34;variable_batch&#34;,
            drop_remainder=True,
            shuffle=True,
        )
        model.fit(training_dataset, epochs=int(epochs))</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="ktrain.text.qa.qa_finetuner.QAFineTuner.finetune"><code class="name flex">
<span>def <span class="ident">finetune</span></span>(<span>self, data, epochs=3, learning_rate=2e-05, batch_size=8, max_seq_length=512)</span>
</code></dt>
<dd>
<div class="desc"><pre><code>Finetune a QA model.

Args:
  data(list): list of dictionaries of the form:
              [{'question': 'What is ktrain?'
               'context': 'ktrain is a low-code library for augmented machine learning.'
               'answer': 'ktrain'}]
  epochs(int): number of epochs.  Default:3
  learning_rate(float): learning rate.  Default: 2e-5
Returns:
  fine-tuned model (i.e., QAFineTuner.model)
</code></pre></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def finetune(
    self, data, epochs=3, learning_rate=2e-5, batch_size=8, max_seq_length=512
):
    &#34;&#34;&#34;
    ```
    Finetune a QA model.

    Args:
      data(list): list of dictionaries of the form:
                  [{&#39;question&#39;: &#39;What is ktrain?&#39;
                   &#39;context&#39;: &#39;ktrain is a low-code library for augmented machine learning.&#39;
                   &#39;answer&#39;: &#39;ktrain&#39;}]
      epochs(int): number of epochs.  Default:3
      learning_rate(float): learning rate.  Default: 2e-5
    Returns:
      fine-tuned model (i.e., QAFineTuner.model)
    ```
    &#34;&#34;&#34;
    if self.model.name_or_path.startswith(&#34;bert-large&#34;):
        warnings.warn(
            &#34;You are fine-tuning a bert-large-* model, which requires lots of memory.  &#34;
            + &#34;If you get a memory error, switch to distilbert-base-cased-distilled-squad.&#34;
        )
    if batch_size &gt; len(data):
        batch_size = len(data)

    model = self.model
    tokenizer = self.tokenizer
    question_column_name = &#34;question&#34;
    context_column_name = &#34;context&#34;
    answer_column_name = &#34;answers&#34;

    # Padding side determines if we do (question|context) or (context|question).
    pad_on_right = tokenizer.padding_side == &#34;right&#34;

    # Training preprocessing
    def prepare_train_features(examples):
        # Some of the questions have lots of whitespace on the left, which is not useful and will make the
        # truncation of the context fail (the tokenized question will take a lots of space). So we remove that
        # left whitespace
        examples[question_column_name] = [
            q.lstrip() for q in examples[question_column_name]
        ]

        # Tokenize our examples with truncation and maybe padding, but keep the overflows using a stride. This results
        # in one example possible giving several features when a context is long, each of those features having a
        # context that overlaps a bit the context of the previous feature.
        tokenized_examples = tokenizer(
            examples[question_column_name if pad_on_right else context_column_name],
            examples[context_column_name if pad_on_right else question_column_name],
            truncation=&#34;only_second&#34; if pad_on_right else &#34;only_first&#34;,
            max_length=max_seq_length,
            stride=128,
            return_overflowing_tokens=True,
            return_offsets_mapping=True,
            # padding=&#34;max_length&#34; if data_args.pad_to_max_length else False,
            padding=&#34;max_length&#34;,
        )

        # Since one example might give us several features if it has a long context, we need a map from a feature to
        # its corresponding example. This key gives us just that.
        sample_mapping = tokenized_examples.pop(&#34;overflow_to_sample_mapping&#34;)
        # The offset mappings will give us a map from token to character position in the original context. This will
        # help us compute the start_positions and end_positions.
        offset_mapping = tokenized_examples.pop(&#34;offset_mapping&#34;)

        # Let&#39;s label those examples!
        tokenized_examples[&#34;start_positions&#34;] = []
        tokenized_examples[&#34;end_positions&#34;] = []

        for i, offsets in enumerate(offset_mapping):
            # We will label impossible answers with the index of the CLS token.
            input_ids = tokenized_examples[&#34;input_ids&#34;][i]
            cls_index = input_ids.index(tokenizer.cls_token_id)

            # Grab the sequence corresponding to that example (to know what is the context and what is the question).
            sequence_ids = tokenized_examples.sequence_ids(i)

            # One example can give several spans, this is the index of the example containing this span of text.
            sample_index = sample_mapping[i]
            answers = examples[answer_column_name][sample_index]
            # If no answers are given, set the cls_index as answer.
            if len(answers[&#34;answer_start&#34;]) == 0:
                tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                tokenized_examples[&#34;end_positions&#34;].append(cls_index)
            else:
                # Start/end character index of the answer in the text.
                start_char = answers[&#34;answer_start&#34;][0]
                end_char = start_char + len(answers[&#34;text&#34;][0])

                # Start token index of the current span in the text.
                token_start_index = 0
                while sequence_ids[token_start_index] != (1 if pad_on_right else 0):
                    token_start_index += 1

                # End token index of the current span in the text.
                token_end_index = len(input_ids) - 1
                while sequence_ids[token_end_index] != (1 if pad_on_right else 0):
                    token_end_index -= 1

                # Detect if the answer is out of the span (in which case this feature is labeled with the CLS index).
                if not (
                    offsets[token_start_index][0] &lt;= start_char
                    and offsets[token_end_index][1] &gt;= end_char
                ):
                    tokenized_examples[&#34;start_positions&#34;].append(cls_index)
                    tokenized_examples[&#34;end_positions&#34;].append(cls_index)
                else:
                    # Otherwise move the token_start_index and token_end_index to the two ends of the answer.
                    # Note: we could go after the last offset if the answer is the last word (edge case).
                    while (
                        token_start_index &lt; len(offsets)
                        and offsets[token_start_index][0] &lt;= start_char
                    ):
                        token_start_index += 1
                    tokenized_examples[&#34;start_positions&#34;].append(
                        token_start_index - 1
                    )
                    while offsets[token_end_index][1] &gt;= end_char:
                        token_end_index -= 1
                    tokenized_examples[&#34;end_positions&#34;].append(token_end_index + 1)

        return tokenized_examples

    dataset = convert_to_dataset(data)
    print(dataset)
    print(dataset[0])

    train_dataset = dataset.map(
        prepare_train_features,
        batched=True,
        num_proc=1,
    )
    optimizer = tf.keras.optimizers.Adam(learning_rate=learning_rate)

    def dummy_loss(y_true, y_pred):
        return tf.reduce_mean(y_pred)

    losses = {&#34;loss&#34;: dummy_loss}
    model.compile(optimizer=optimizer, loss=losses)

    training_dataset = convert_dataset_for_tensorflow(
        train_dataset,
        batch_size=batch_size,
        dataset_mode=&#34;variable_batch&#34;,
        drop_remainder=True,
        shuffle=True,
    )
    model.fit(training_dataset, epochs=int(epochs))</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="ktrain.text.qa" href="index.html">ktrain.text.qa</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="ktrain.text.qa.qa_finetuner.convert_dataset_for_tensorflow" href="#ktrain.text.qa.qa_finetuner.convert_dataset_for_tensorflow">convert_dataset_for_tensorflow</a></code></li>
<li><code><a title="ktrain.text.qa.qa_finetuner.convert_to_dataset" href="#ktrain.text.qa.qa_finetuner.convert_to_dataset">convert_to_dataset</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="ktrain.text.qa.qa_finetuner.QAFineTuner" href="#ktrain.text.qa.qa_finetuner.QAFineTuner">QAFineTuner</a></code></h4>
<ul class="">
<li><code><a title="ktrain.text.qa.qa_finetuner.QAFineTuner.finetune" href="#ktrain.text.qa.qa_finetuner.QAFineTuner.finetune">finetune</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>