Home

Welcome to the Project KARL Documentation

This is the official documentation for Project KARL (Kotlin Adaptive Reasoning Learner), an open-source library for building privacy-first, on-device adaptive AI models.

Whether you are a developer looking to integrate KARL into your application, a contributor wanting to improve the core library, or just curious about the architecture of on-device AI, you've come to the right place.

What is Project KARL?

Project KARL provides a framework and reference implementations for embedding intelligent, personalized features into applications without compromising user data privacy. Its core philosophy is built on local-first processing, where all learning and inference happen exclusively on the user's device.

---

Getting Started

New to Project KARL? The Getting Started guide is the best place to begin. It will walk you through setting up your environment and creating your first basic integration.

• Getting Started

---

Main Documentation Sections

Navigate through the documentation using the sections below. We recommend reading them in order if you are new to the project.

• 1. Introduction to KARL

  • Learn about the vision, mission, and core principles behind Project KARL. Understand the problems it solves and how it compares to traditional cloud-based AI.

• 2. Getting Started

  • A step-by-step guide to setting up your project, adding dependencies, and creating your first minimal KARL integration.

• 3. Core Concepts

  • A deep dive into the fundamental building blocks of KARL, including the Container Model, Data Handling, and the Learning & Inference processes.

• 4. Integration Guide

  • Detailed guidance on effectively weaving KARL's capabilities into your application, from designing interaction data to integrating with UI frameworks.

• 5. Privacy & Security

  • An overview of KARL's privacy-first architecture, data security recommendations, and user control features.

• 6. Modules Overview

  • A breakdown of the different modules in the Project KARL repository, explaining the purpose of each (e.g., :karl-core, :karl-room).

---

For Contributors

Interested in helping build Project KARL? These resources are for you.

• The KARL Core (For Contributors)

  • Technical insights into the internal architecture, development setup, and roadmap for those looking to contribute to the library itself.

• Main Contribution Guidelines

  • Our official guide for reporting issues, submitting pull requests, and our code of conduct.

---

Resources & Examples

• API Reference

  • An overview of the key public APIs. For exhaustive details, refer to the generated Dokka documentation.

• Examples and Tutorials

  • A collection of practical examples and step-by-step tutorials for various use cases.

• FAQ & Troubleshooting

  • Find answers to frequently asked questions and solutions to common problems.

• Glossary

  • Definitions of key terms and concepts used throughout the documentation.