From 8df4ba4ae623d7c62a0856496e4491ceb00a5e7d Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Tue, 1 Oct 2024 01:05:56 +0300 Subject: [PATCH] Refactor documentation. --- doc/index.org | 86 +++++++++++++++++++++++++-------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/doc/index.org b/doc/index.org index 8eba7c6..15a90db 100644 --- a/doc/index.org +++ b/doc/index.org @@ -8,33 +8,6 @@ #+OPTIONS: H:20 num:20 #+OPTIONS: author:nil -* General -- This program is free software: released under Creative Commons Zero - (CC0) license. - -- Program author: - - Svjatoslav Agejenko - - Homepage: https://svjatoslav.eu - - Email: mailto://svjatoslav@svjatoslav.eu - -- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]] - -** Source code -:PROPERTIES: -:ID: f5740953-079b-40f4-87d8-b6d1635a8d39 -:END: -- [[https://www2.svjatoslav.eu/gitweb/?p=alyverkko-cli.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] - -- [[https://www2.svjatoslav.eu/gitweb/?p=alyverkko-cli.git;a=summary][Browse Git repository online]] - -- Clone Git repository using command: - : git clone https://www3.svjatoslav.eu/git/alyverkko-cli.git - -- See [[https://www3.svjatoslav.eu/projects/alyverkko-cli/apidocs/][JavaDoc]]. - -- See [[https://www3.svjatoslav.eu/projects/alyverkko-cli/graphs/][automatically generated class diagrams]]. Here is [[https://www3.svjatoslav.eu/projects/javainspect/legend.png][legend]] to help - understand diagrams. Diagrams were generated using [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect tool]]. - * Introduction The *Älyverkko CLI* application is a user-friendly tool developed in @@ -45,7 +18,7 @@ mode. To illustrate its capabilities: Imagine harnessing the power of a vast language model, boasting approximately 100 billion parameters, solely relying on CPU computations and leveraging the open-source software -llama.cpp. This setup requires a modern consumer-grade CPU and +*llama.cpp*. This setup requires a modern consumer-grade CPU and approximately 128 GB of RAM. To put this into perspective, 128 GB of RAM is financially comparable to purchasing a high-quality smartphone, making it an economical option for many users. @@ -67,7 +40,7 @@ inclined to read manually. The primary objective of the *Älyverkko CLI* project is to identify and enable applications where this "slow but smart" AI can excel. By -utilizing llama.cpp as its inference engine, the project aims to +utilizing *llama.cpp* as its inference engine, the project aims to unlock a variety of uses where batch processing is more advantageous than real-time interaction. @@ -150,19 +123,19 @@ Draft an outline for a book on science fiction and improve its plot. 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 +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. +Here is [[https://www.svjatoslav.eu/writing/Whispers%20in%20the%20Stream%20of%20Time.html][example sci-fi book]] that was written with the help of +*Älyverkko CLI*. * Installation -For information about installation and configuration, see [[id:e469ec1e-402a-476d-a849-662a48eb4f90][Älyverkko -CLI application setup tutorial]]. +See [[id:e469ec1e-402a-476d-a849-662a48eb4f90][Älyverkko CLI application installation tutorial]]. -* Task preparation +* Usage +** Task preparation :PROPERTIES: :ID: 4b7900e4-77c1-45e7-9c54-772d0d3892ea :END: @@ -175,7 +148,7 @@ Suggested usage flow is to prepare AI assignments within the Älyverkko CLI mail directory using normal text editor. Once AI assignment is ready for processing, you should [[id:883d6e7c-60e0-422b-8c00-5cdc9dfec20d][initiate AI processing]] on that file. -** "joinfiles" command +*** "joinfiles" command *Note:* See also alternative solution with similar goal: [[https://github.com/aerugo/prelude][prelude]]. The *joinfiles* command is a utility for aggregating the contents of @@ -184,7 +157,7 @@ AI. This is particularly useful for preparing comprehensive problem statements from various source files, such as software project directories or collections of text documents. -*** Usage +**** Usage To use the *joinfiles* command, specify the source directory containing the files you wish to join and a topic name that will be @@ -207,7 +180,7 @@ in text editor for further editing or review: alyverkko-cli joinfiles -t "my_topic" --edit #+end_example -*** Options +**** Options - **-s, --src-dir**: Specifies the source directory from which to join files. @@ -222,7 +195,7 @@ alyverkko-cli joinfiles -t "my_topic" --edit - **-e, --edit**: Opens the joined file in text editor after the join operation is complete. -*** Example Use Case +**** Example Use Case Imagine you have a software project with various source files that you want to analyze using AI. You can use the *joinfiles* command to @@ -239,7 +212,7 @@ and open text editor on the file, so that you can add your analysis instructions or problem statement. Finally you [[id:883d6e7c-60e0-422b-8c00-5cdc9dfec20d][Initiate AI processing]] and after some time, you will get results and the end of the file. -* Initiate AI processing +** Initiate AI processing :PROPERTIES: :ID: 883d6e7c-60e0-422b-8c00-5cdc9dfec20d :END: @@ -282,7 +255,7 @@ beginning of the file. This way AI will process file again and file becomes stateful conversation. If you use GNU Emacs text editor, you can benefit from [[id:25038854-c905-4b26-9670-cca06600223e][purpose-built GNU Emacs utilities]]. -**** Helpful GNU Emacs utilities +** Helpful GNU Emacs utilities :PROPERTIES: :ID: 25038854-c905-4b26-9670-cca06600223e :END: @@ -291,7 +264,7 @@ Note: GNU Emacs and following Emacs Lisp utilities are not required to use Älyverkko CLI. Their purpose is to increase comfort for existing GNU Emacs users. -***** Easily compose new problem statement for AI from emacs +*** Easily compose new problem statement for AI from emacs 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 @@ -327,7 +300,7 @@ new file and open it for editing. #+end_src -***** Easily signal to AI that problem statement is ready for solving +*** Easily signal to AI that problem statement is ready for solving The function =alyverkko-compute= is designed to enhance the workflow of users working with the Älyverkko CLI application by automating the @@ -388,6 +361,33 @@ something like this: (save-buffer))) #+end_src +* Getting the source code +- This program is free software: released under Creative Commons Zero + (CC0) license. + +- Program author: + - Svjatoslav Agejenko + - Homepage: https://svjatoslav.eu + - Email: mailto://svjatoslav@svjatoslav.eu + +- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]] + +** Source code +:PROPERTIES: +:ID: f5740953-079b-40f4-87d8-b6d1635a8d39 +:END: +- [[https://www2.svjatoslav.eu/gitweb/?p=alyverkko-cli.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]] + +- [[https://www2.svjatoslav.eu/gitweb/?p=alyverkko-cli.git;a=summary][Browse Git repository online]] + +- Clone Git repository using command: + : git clone https://www3.svjatoslav.eu/git/alyverkko-cli.git + +- See [[https://www3.svjatoslav.eu/projects/alyverkko-cli/apidocs/][JavaDoc]]. + +- See [[https://www3.svjatoslav.eu/projects/alyverkko-cli/graphs/][automatically generated class diagrams]]. Here is [[https://www3.svjatoslav.eu/projects/javainspect/legend.png][legend]] to help + understand diagrams. Diagrams were generated using [[https://www3.svjatoslav.eu/projects/javainspect/][JavaInspect tool]]. + * TODO Ideas to be possibly implemented in the future: -- 2.20.1