Älyverkko CLI application

Problem Statement:

Analyze a set of customer reviews to determine overall sentiment and extract key features that customers appreciate or dislike about a product.

Usage Procedure:

1. User collects customer reviews in plain text format within the configured mail directory. Lets say, about 150 kilobytes of reviews per input file (this is dictated by AI model available context size).
2. Each review file is prefixed with "TOCOMPUTE:".
3. The Älyverkko CLI application processes these files, generating sentiment analysis results and feature extraction insights.
4. Results are appended to the original files in org-mode syntax, indicating AI responses.

Problem Statement:

Generate code snippets for a new software module based on detailed specifications provided by the developer.

Usage Procedure:

1. Developer writes specifications in a text file within the mail directory, prefixed with "TOCOMPUTE:". Text file also contains relevant parts of the program source code and documentation. Älyverkko CLI joinfiles subcommand can be used to facilitate such text file preparation.
2. The Älyverkko CLI application processes this file and generates the corresponding code snippets. The generated code is appended to the original specifications file, organized using org-mode syntax.
3. Developer can review proposed changes and then integrate them back into original program source code.

Note: Most of the Älyverkko CLI program code is written in such a way by AI. This script is used to facilitate the process.

Problem Statement:

Draft an outline for a book on science fiction and improve its plot.

Usage Procedure:

1. The book author writes a brief describing the outline of the plot and his book main idea for the novel.
2. Älyverkko CLI processes this description and generates an outline with suggested headings and suggests possible improvements to the plot.
3. The AI-generated outline is appended to the original brief, formatted using org-mode syntax.

The application is configured using a YAML-formatted configuration file. Below is an example of how the configuration file might look:

mail_directory: "/home/user/AI/mail"
models_directory: "/home/user/AI/models"
default_temperature: 0.7
llama_cpp_dir_path: "/home/user/AI/llama.cpp/"
batch_thread_count: 10
thread_count: 6
prompts_directory: "/home/user/.config/alyverkko-cli/prompts"
models:
  - alias: "default"
    filesystem_path: "WizardLM-2-8x22B.Q5_K_M-00001-of-00005.gguf"
    context_size_tokens: 64000
    end_of_text_marker: null
  - alias: "maid"
    filesystem_path: "daringmaid-20b.Q4_K_M.gguf"
    context_size_tokens: 4096
    end_of_text_marker: null

Here are available parameters:

mail_directory

Directory where AI will look for files that contain problems to solve.

models_directory

Directory where AI models are stored.

• This option is mandatory.

prompts_directory

Directory where prompts are stored.

Example prompts directory content:

default.txt
writer.txt

Prompt name is file name without extension. File extension should be txt.

Example content for writer.txt:

You are best-selling book writer.

default_temperature

Defines the default temperature for AI responses, affecting randomness in the generation process. Lower values make the AI more deterministic and higher values make it more creative or random.

• Default value: 0.7

llama_cpp_dir_path

Specifies the filesystem path to the cloned and compiled llama.cpp directory.

• Example Value: home/user/AI/llama.cpp
• This option is mandatory.

batch_thread_count

Specifies the number of threads to use for input prompt processing. CPU computing power is usually the bottleneck here.

• Default value: 10

thread_count

Sets the number of threads to be used by the AI during response generation. RAM data transfer speed is usually bottleneck here. When RAM bandwidth is saturated, increasing thread count will no longer increase processing speed, but it will still keep CPU cores unnecessarily busy.

• Default value: 6

models

List of available large language models.

alias

Short model alias. Model with alias "default" would be used by default.

filesystem_path

File name of the model as located within models_directory

context_size_tokens

Context size in tokens that model was trained on.

end_of_text_marker

Some models produce certain markers to indicate end of their output. If specified here, Älyverkko CLI can identify and remove them so that they don't leak into conversation. Default value is: null.

Once Älyverkko CLI is installed and properly configured, you can run following command at commandline to see what models are available to it:

alyverkko-cli listmodels

The selftest command performs a series of checks to ensure the system is configured correctly:

alyverkko-cli selftest

It verifies:

• Configuration file integrity.
• Model directory existence.
• The presence of the llama.cpp executable.

1. Open your terminal.

2. Run the command:

   alyverkko-cli mail
   

3. The application will start monitoring the configured mail directory for incoming messages and process them accordingly in endless loop.
4. To terminate Älyverkko CLI, just hit CTRL+c on the keyboard, or close terminal window.

1. Access the application launcher or application menu on your desktop environment.
2. Search for "Älyverkko CLI".
3. Click on the icon to start the application. It will open its own terminal.
4. If you want to stop Älyverkko CLI, just close terminal window.

During Älyverkko CLI installation, installation script will prompt you if you want to install systemd service. If you chose Y, Alyverkko CLI would be immediately started in the background as a system service. Also it will be automatically started on every system reboot.

To view service status, use:

systemctl -l status alyverkko-cli

If you want to stop or disable service, you can do so using systemd facilities:

sudo systemctl stop alyverkko-cli
sudo systemctl disable alyverkko-cli

To use the joinfiles command, specify the source directory containing the files you wish to join and a topic name that will be used to generate the output file name:

alyverkko-cli joinfiles -s /path/to/source/directory -t "my_topic"

If desired, you can also specify a glob pattern to match only certain files within the directory:

alyverkko-cli joinfiles -s /path/to/source/directory -p "*.java" -t "my_topic"

After joining the files, you can choose to open the resulting document in text editor for further editing or review:

alyverkko-cli joinfiles -t "my_topic" --edit

• -s, –src-dir: Specifies the source directory from which to join files.
• -p, –pattern: An optional glob pattern to match specific files within the source directory.
• -t, –topic: The topic name that will be used as a basis for the output file name and should reflect the subject matter of the joined content.
• -e, –edit: Opens the joined file in text editor after the join operation is complete.

Imagine you have a software project with various source files that you want to analyze using AI. You can use the joinfiles command to create a single document for processing:

alyverkko-cli joinfiles -s /path/to/project -p "*.java" -t "software_analysis" --edit

This will recursively search the project directory for Java source files, aggregate their contents into a file named software_analysis.org (within AI processor input files directory), and open text editor on the file, so that you can add your analysis instructions or problem statement. Finally you Initiate AI processing and after some time, you will get results and the end of the file.

The Elisp function ai-new-topic facilitates the creation and opening of a new Org-mode file dedicated to a user-defined topic within a specified directory. Now you can use this file within emacs to compose you problem statement to AI.

When ai-new-topic function triggered, it first prompts the user to input a topic name. This name will serve as the basis for the filename and the title within the document.

The function then constructs a file path by concatenating the pre-defined alyverkko-topic-files-directory (which should be set to your topics directory), the topic name, and the .org extension. If a file with this path does not already exist, the function will create a new file and open it for editing.

(defvar alyverkko-topic-files-directory "/home/user/my-ai-mail-directory/"
  "Directory where topic files are stored.")

(defun alyverkko-new-topic ()
  "Create and open a topic file in the specified directory."
  (interactive)
  (let ((topic (read-string "Enter topic name: ")))
    (let ((file-path (concat alyverkko-topic-files-directory topic ".org")))
      (if (not (file-exists-p file-path))
          (with-temp-file file-path
            ))
      (find-file file-path)
      (goto-char (point-max))
      (org-mode))))

The function alyverkko-compute is designed to enhance the workflow of users working with the Älyverkko CLI application by automating the process of marking text files for computation with a specific AI model prompt. Älyverkko CLI applications can process vast amounts of data using language models, and typically require an indication of which processing prompt to use for each batch of text. This function streamlines the workflow by allowing the user to interactively select a specific prompt and automatically inserting the appropriate directive at the beginning of the current buffer in Emacs.

Adjust ~/.config/alyverkko-cli/prompts/ to point to your prompts directory.

  (defun alyverkko-compute ()
  "Select a prompt file name interactively and insert it at the beginning of the current buffer."
  (interactive)
  (let ((prompt-dir "~/.config/alyverkko-cli/prompts/"))
    (if (file-exists-p prompt-dir)
        (let* ((files (directory-files prompt-dir t "\\`[^.].*\\.txt\\'"))  ; Filter to include only .txt files, ignoring hidden files
               (aliases (mapcar (lambda (f) (file-name-base f)) files)))
          (if aliases
              (let ((selected-alias (completing-read "Select prompt alias: " aliases)))
                (alyverkko-insert-tocompute-line selected-alias))
            (message "No prompt files found.")))
      (message "Prompt directory not found."))))

(defun alyverkko-insert-tocompute-line (prompt-alias)
  "Inserts TOCOMPUTE line with selected PROMPT-ALIAS at the beginning of the buffer."
  (save-excursion  ; Preserve the original cursor location in the buffer
    (goto-char (point-min))
    (insert (format "TOCOMPUTE: prompt=%s\n" prompt-alias))
    (save-buffer)))