Appendices

Note: as the usage and deployment of Ask Bob is inextricably linked to the FISE Concierge and FISE Lounge projects of teams 25 and 38 due to the integration of the IBM FISE projects, please view the usage and deployment of our project within the context of the user and deployment manuals of those teams as submitted with their respective report websites in addition to those included below.

User manual

A detailed user manual for installing, running, developing with and testing the Ask Bob voice assistant framework is available at the following link: AskBob-User-Manual.pdf (16 pages)

A user manual for navigating and using the Ask Bob plugin configuration generator web app is available at the following link: Configuration-Generator-User-Manual.pdf (13 pages)

A user manual for using the skills viewer for Ask Bob servers is available at the following link: Skills-Viewer-User-Manual.pdf (3 pages)

Deployment manual

A deployment guide for deploying a demonstration project using the Ask Bob voice assistant framework on Windows is available at the following link: AskBob-Deployment-Guide-Windows.pdf (8 pages)

The guide above would be suitable for deploying Ask Bob to an Intel Core i3-based NUC device running Windows. For more in-depth information on installation and usage, including installation on Ubuntu Linux, see the Ask Bob user manual.

A deployment manual for deploying the Ask Bob plugin configuration generator web app is available at the following link: config-deployment.pdf (6 pages)

A deployment manual for deploying the skills viewer for Ask Bob servers is available at the following link: skills-viewer-deployment.pdf (6 pages)

Web app name Link
Configuration generator https://askbobconfig.netlify.app/
Skills viewer https://askbobskillsviewer.netlify.app/

The software is an early proof of concept for development purposes and should not be used as-is in a live environment without further redevelopment and/or testing. No warranty is given and no real data or personally identifiable data should be stored. Usage and its liabilities are your own.

This project is licensed under the GNU Affero General Public License, version 3 (AGPLv3).

Ask Bob
Copyright (C) 2021  Jeremy Lo Ying Ping, Akhere Ihoeghinlan

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

This project was developed by Jeremy Lo Ying Ping and Akhere Ihoeghinlan.

This project is linked to the IBM FISE Concierge and FISE Lounge projects of teams 25 and 38, respectively, containing the following team members:

Our clients were Prof John McNamara (IBM), Prof Joseph Connor (NHS), Dr Dean Mohamedally (UCL), Dr Graham Roberts (UCL), Sheena Visram (UCL) and Alan Fish (Apperta Foundation).

We were supervised by Dr Dean Mohamedally (UCL). Our assigned teaching assistant Ahmed Shahin (UCL).

University College London

Library licenses table

Ask Bob voice assistant framework

Library Project page License type
coloredlogs https://pypi.org/project/coloredlogs/ MIT
deepspeech https://pypi.org/project/deepspeech/ Mozilla Public License 2.0 (MPL-2.0)
halo https://pypi.org/project/halo/ MIT
numpy https://pypi.org/project/numpy/ BSD
PyAudio https://pypi.org/project/PyAudio/ MIT
pytest https://pypi.org/project/pytest/ MIT
pytest-asyncio https://pypi.org/project/pytest-asyncio/ Apache Software License (Apache 2.0)
pytest-sanic https://pypi.org/project/pytest-sanic/ MIT
pytest-cov https://pypi.org/project/pytest-cov/ MIT
pyttsx3 https://pypi.org/project/pyttsx3/ GNU General Public License v3 (GPLv3)
rasa https://pypi.org/project/rasa/ Apache Software License (Apache-2.0)
recommonmark https://pypi.org/project/recommonmark/ MIT
sanic https://pypi.org/project/sanic/ MIT
Sanic-Cors https://pypi.org/project/Sanic-Cors/ MIT
scipy https://pypi.org/project/scipy/ BSD
spacy https://pypi.org/project/spacy/ MIT
sphinx https://pypi.org/project/Sphinx/ BSD
sphinx-rtd-theme https://pypi.org/project/sphinx-rtd-theme/ MIT
webrtcvad https://pypi.org/project/webrtcvad/ MIT

Additionally, the SpaCy en_core_web_md pretrained English model we use is licensed under the MIT license. The Mozilla DeepSpeech model and external scorer we recommend is licensed under the MPL-2.0 license just as DeepSpeech itself in the table above.

Configuration generator web app

Library Project page License type
@material-ui/core https://www.npmjs.com/package/@material-ui/core MIT
@material-ui/icons https://www.npmjs.com/package/@material-ui/icons MIT
@material-ui/lab https://www.npmjs.com/package/@material-ui/lab MIT
react-sortable https://www.npmjs.com/package/react-sortable MIT
react-dom https://www.npmjs.com/package/react-dom MIT
react-redux https://www.npmjs.com/package/react-redux MIT
react-router-dom https://www.npmjs.com/package/react-router-dom MIT
react-scripts https://www.npmjs.com/package/react-scripts MIT
react-sortable https://www.npmjs.com/package/react-sortable MIT
Formik https://www.npmjs.com/package/formik Apache-2.0

Skills viewer web app

Library Project page License type
@material-ui/core https://www.npmjs.com/package/@material-ui/core MIT
@material-ui/icons https://www.npmjs.com/package/@material-ui/icons MIT
@material-ui/lab https://www.npmjs.com/package/@material-ui/lab MIT
query-string https://www.npmjs.com/package/query-string MIT
serve https://www.npmjs.com/package/serve MIT

Development blog website

Project Project page License type
Jekyll https://github.com/jekyll/jekyll MIT
Cayman https://github.com/pages-themes/cayman CC0-1.0 License

Report website

Project Project page License type
Jekyll https://github.com/jekyll/jekyll MIT
Hyde https://github.com/poole/hyde MIT