Wondering what’s next for npm?Check out our public roadmap! »

    @tensorflow-models/qna
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    Question and Answer

    Use a pre-trained model to answer questions based on the content of a given passage.

    How it works

    The model can be used to build a system that can answer users’ questions in natural language. It was created using a pre-trained BERT model fine-tuned on SQuAD 1.1 dataset.

    (BERT)[https://github.com/google-research/bert], or Bidirectional Encoder Representations from Transformers, is a method of pre-training language representations which obtains state-of-the-art results on a wide array of Natural Language Processing tasks.

    This app uses a compressed version of BERT, (MobileBERT)[https://openreview.net/forum?id=SJxjVaNKwB], that runs 4x faster and has 4x smaller model size.

    (SQuAD)[https://rajpurkar.github.io/SQuAD-explorer/], or Stanford Question Answering Dataset, is a reading comprehension dataset consisting of articles from Wikipedia and a set of question-answer pairs for each article.

    The model takes a passage and a question as input, then returns a segment of the passage that most likely answers the question. It requires semi-complex pre-processing including tokenization and post-processing steps that are described in the BERT (paper)[https://arxiv.org/abs/1810.04805] and implemented in the sample app. This model is also available in (TFLite)[https://www.tensorflow.org/lite/models/bert_qa/overview].

    Usage

    There are two main ways to get this model in your JavaScript project: via script tags or by installing it from NPM and using a build tool like Parcel, WebPack, or Rollup.

    via Script Tag

    <!-- Make sure your page supports utf-8 characterset. -->
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <!-- Load TensorFlow.js. This is required to use the qna model. -->
    <script src="https://cdn.jsdelivr.net/npm/@tensorflow/tfjs"> </script> 
    <!-- Load the qna model. -->
    <script src="https://cdn.jsdelivr.net/npm/@tensorflow-models/qna"> </script> 
     
    <!-- Place your code in the script tag below. You can also use an external .js file -->
    <script>
      // Notice there is no 'import' statement. 'qna' and 'tf' is
      // available on the index-page because of the script tag above.
     
      // Load the model.
      qna.load().then(model => {
        // Find the answers
        model.findAnswers(question, passage).then(answers => {
          console.log('Answers: ', answers);
        });
      });
    </script> 

    via NPM

    // Note: you do not need to import @tensorflow/tfjs here, but make sure you have installed the peer dependencies for tfjs-core and tfjs-converter.
     
    import * as qna from '@tensorflow-models/qna';
     
    // Load the model.
    const model = await qna.load();
     
    // Finding the answers
    const answers = await model.findAnswers(question, passage);
     
    console.log('Answers: ');
    console.log(answers);

    Try the demo here! You can also take a look at the source code of the demo app.

    Note

    Please make sure your web page supports utf-8 character set. To achieve that you can add following line to your page:

      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

    API

    Loading the model

    When using a script tag, the package is available as qna in the global namespace.

    // you can load the model without providing the config object.
    model = await qna.load();
    // or you can specify the model url.
    config = {modelUrl: 'https://yourown-server/qna/model.json'};
    customModel = await qna.load(config);

    Args: config Model Config structure with following attributes:

    • modelUrl: An optional string that specifies custom url of the model. This is useful for area/countries that don't have access to the model hosted on GCP.

    Returns a model object.

    Find the answers

    You can find the answers for a given question and associated passage with the model without needing to create a Tensor. model.findAnswers takes two inputs (question and passage) and returns an array of answers ranked by their scores.

    This method exists on the model that is loaded from qna.load().

    model.findAnswers(
      question: string, passage: string
    )

    Args:

    • question: The question string.
    • passage: The content to extract answers from.

    Returns an Promise of array of answers that look like following:

    [{
      text: "Sundar Pichai",
      startIndex: 1143,
      endIndex: 1156,
      score: 0.8380282521247864
    }]

    In which the text is of string type and represents the answer body, and score is a number, indicates the confident level. The startIndex is the index of the starting character of the answer in the passage. The endIndex is index of the last character of the answer.

    Here is an example run of the QnA model:

    const passage = "Google LLC is an American multinational technology company that specializes in Internet-related services and products, which include online advertising technologies, search engine, cloud computing, software, and hardware. It is considered one of the Big Four technology companies, alongside Amazon, Apple, and Facebook. Google was founded in September 1998 by Larry Page and Sergey Brin while they were Ph.D. students at Stanford University in California. Together they own about 14 percent of its shares and control 56 percent of the stockholder voting power through supervoting stock. They incorporated Google as a California privately held company on September 4, 1998, in California. Google was then reincorporated in Delaware on October 22, 2002. An initial public offering (IPO) took place on August 19, 2004, and Google moved to its headquarters in Mountain View, California, nicknamed the Googleplex. In August 2015, Google announced plans to reorganize its various interests as a conglomerate called Alphabet Inc. Google is Alphabet's leading subsidiary and will continue to be the umbrella company for Alphabet's Internet interests. Sundar Pichai was appointed CEO of Google, replacing Larry Page who became the CEO of Alphabet."
    const question = "Who is the CEO of Google?"
    const model = await qna.load();
    const answers = await model.findAnswers(question, passage);
    console.log(answers);
    /**
    [{
      text: "Sundar Pichai",
      startIndex: 1143,
      endIndex: 1156,
      score: 0.8380282521247864
    }]
    **/

    Keywords

    none

    Install

    npm i @tensorflow-models/qna

    DownloadsWeekly Downloads

    100

    Version

    1.0.0

    License

    Apache-2.0

    Unpacked Size

    91.3 kB

    Total Files

    18

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar