InstructLab App proposal

This is a proposal for creating a InstructLab Application Co-authored-by: Lisa Waugh <[email protected]> Signed-off-by: JJ Asghar <[email protected]>
instructlab · Jun 13, 2024 · 9671dc6 · 9671dc6
1 parent c52d53f
commit 9671dc6
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/docs/instructlab-app.md b/docs/instructlab-app.md
@@ -0,0 +1,30 @@
+# InstructLab App
+
+## Scope
+
+This document is targeted for Mac applications, but the idea could easily be transferred to other operating systems.
+
+## Problem statement
+
+Starting InstructLab on your local laptop is hard. It requires a significant amount of `python` knowledge and terminal
+work, that is unrealistic for a non technologist to use. Having to install `git` specific versions of `python` and
+`xcode` requires a level of expertise that will create barriers of adoption to the InstructLab project.
+
+## Proposed solution
+
+[ollama][ollama] has a Mac application that is a double click installation for their server to run the commands
+locally. We propose creating the same "system bar" application, with the ability to run `ilab serve` in the background
+and a possible way to do `ilab chat` from said application.
+
+Having the `ilab` dog up in the system bar telling you that `ilab serve` is running, could open up the opportunity
+to have a model open to ask a `-qq` question to the local model, and even an ability to open up a "long running"
+conversation via a web browser or the like.
+
+## Next steps
+
+1. Create a simple MVP of starting the `ilab serve` application, with controls for the `serve` options, including
+   what model you'd like to run, i.e. Granite or Merlinite.
+2. Create an option to do a `-qq` to the via the drop down
+3. Create a `ilab chat` type interface via a window or web browser.
+
+[ollama]: https://ollama.com/download/mac