Floppy-QA

This app will implement question answering on Electron framework, using Tensorflow.js models that rely on Transformer architecture and are fine-tuned for QA NLP tasks.

Presentation

You can find here a copy of the presentation for the workshop "Day with Industrial partners", held at Masaryk University, used to introduce the work of the author:
Presentation PDF

Step 1

Prerequisites

Install node js (Version 16 LTS) from the official download page
Clone this repository:

git clone https://github.com/spaghiajoeojo/floppy-qa.git

A quick overview of the code

In this repository we have a boilerplate to code an Electron app.

root folder
├─ src
│  ├─ assets        - images
│  ├─ classes       - javascript objects used in this project
│  ├─ components    - Vue components
│  └─ model         - folder for our ML model
├─ package.json
└─ other configuration files

This app is configured with webpack, the entry point of our web application is index.html.
In main.js we have the background process logic that is used to create a window and to register a custom protocol schema (static://) to load external files (more on that later).
In renderer.js we have all the application logic that will run in the renderer process like a browser.

Vue

Our application is written using Vue 3. You can browse the components already included in the src/components folder:

MessageComponent -> is a simple component used to render a message of a chat
DropArea -> we need it to read text from a file dropped or selected
ChatComponent -> the true core of our application. At this moment it's logic less.

Let's start our app

First thing to do is check that everything works:

npm start

should start our Electron app.

To build our app as an executable we have to run:

npm run make

Step 2

Building the chat

We are now ready to write our chat. Let's modify ChatComponent.vue.
First thing first we have to create a reference for all the messages in the conversation and manage user input to send a message:

const messageText = ref(null);
const messages = ref([]);
const loading = ref(false);

// methods
const sendMessage = () => {
  if (!messageText.value) return;
  const text = messageText.value;
  messages.value = [
    ...messages.value,
    new Message({ text, from: "me" }),
  ];
  loading.value = true;
  setTimeout(() => {
    messages.value = [
      ...messages.value,
      new Message({ text: `You said: ${text}` }),
    ];
    loading.value = true;
  }, 1500);
  messageText.value = null;
};

Now we can integrate these lines of code in our template:

<template>
  <div class="chat">
    <template v-if="file">
      <div class="chat-messages" ref="messageList">
        <message-component
          v-for="(msg, index) in messages"
          :key="index"
          :message="msg"
        >
        </message-component>
      </div>
      <form class="chat-bottom" @submit.prevent="sendMessage">
        <input v-model="messageText" type="text" />
        <button>Send</button>
      </form>
    </template>
    <drop-area v-else v-model="file"></drop-area>
  </div>
</template>

One more little thing

Right now if the conversation is quite long we have to scroll down for each new message sent or received. Let's fix it:

watch(messages, () => {
  nextTick(() => {
    messageList.value.scrollTop = messageList.value.scrollHeight;
  });
});

At every change of messages we scroll down after the render of the conversation.

Step 3

Let's bring in AI

It's time to install Tensorflow.js as a dependency:

npm install @tensorflow/tfjs

Another package needed is @tensorflow-models/qna but since we are making an offline app we have to use a slightly different package that allow us to load the model from file system instead of downloading it from the web.

npm install tensorflow-qna-local-model

Download the model

Our model is a pre-trained model hosted on tfhub.dev and can be downloaded clicking here or visiting:

https://tfhub.dev/tensorflow/tfjs-model/mobilebert/1

Once downloaded we have to unzip it and put all the files inside src/model folder. This folder is a special directory in our app that can serve static files with a custom protocol schema (static://).

Loading Floppy's brain

Let's create a new file services/qna.js and import tensorflow.js:

import * as tf from '@tensorflow/tfjs';
import * as qna from "tensorflow-qna-local-model";

// this is the backend recommended but you can also cpu 'cpu'
tf.setBackend('webgl');

We're going to initialize it at startup time

const modelUrl = "static://model/model.json";
const vocabUrl = "static://model/processed_vocab.json";

let model;

const init = async () => {
    model = await qna.load({ modelUrl, vocabUrl });
};

init();

Finally let's write a function to export:

const findAnswers = async (question, context) => {
    if (!model) {
        throw new Error('Model not initialized');
    }
    return model.findAnswers(question, context);
};

export { findAnswers };

Now we can import our service in ChatComponent.vue:

import { findAnswers } from "@/services/qna";

and later in sendMessage function:

// methods
const sendMessage = () => {
  if (!messageText.value) return;
  const text = messageText.value;
  messages.value = [...messages.value, new Message({ text, from: "me" })];
  loading.value = true;
  setTimeout(() => {
    findAnswers(text, file.value.content).then((answers) => {
      console.log(answers);
      const [ans] = answers;
      const msg = ans || "I don't know...";
      loading.value = false;
      messages.value = [
        ...messages.value,
        new Message({ text: msg, ...ans, from: "bot" }),
      ];
    });
  }, 0);

  messageText.value = null;
};

spaghiajoeojo / floppy-qa Goto Github PK

floppy-qa's Introduction

Floppy-QA

Presentation

Step 1

Prerequisites

A quick overview of the code

Vue

Let's start our app

Step 2

Building the chat

One more little thing

Step 3

Let's bring in AI

Download the model

Loading Floppy's brain

floppy-qa's People

Contributors

Stargazers

Watchers

Recommend Projects

Recommend Topics

Recommend Org