Welcome to BrainKB

This book serves as a comprehensive resource on BrainKB, offering detailed information about its guiding principles, architecture, service components, and the various tools and libraries developed for it. Additionally, it functions as technical documentation, providing instructions for deploying BrainKB services and user interface (UI) components.

Warning

This document is currently under development. The content is expected to undergo modifications without prior notification.

Important

This book is also expected to replace the BrainKB design document.

Last Updated: September 30, 2024

Purpose of the book

• Comprehensive Resource on BrainKB: To provide detailed information about BrainKB, including its guiding principles, architecture, and service components.

• Technical Documentation: To serve as a technical manual with instructions for deploying BrainKB services and user interface (UI) components.

• Information on Tools and Libraries: To list and describe the tools and libraries developed for BrainKB.

• Guidance on Deployment: To offer step-by-step instructions for the deployment of BrainKB services and UI components.

Check out the content pages to see more.

Before you Begin

• 1. Getting Started

BrainKB Overview

• 2. What is BrainKB?
• 3. Audience and Use Case Overview
• 4. Architecture of BrainKB

BrainKB Microservices

• 5. Ingestion service

BrainKB User Interface

• 6. User Interface Overview

Deployment

• 7. Deployment of User Interface
• 8. Deployment of BrainKB Services

Benchmarking

• 9. Benchmarking

Miscellaneous

• 10. List of Libraries/Source Code