Merge pull request #80 from fractalego/writing-new-docs

updated docs
fractalego · Dec 23, 2023 · 20bdae8 · 20bdae8
2 parents 2d28bfc + 872143a
commit 20bdae8
Show file tree

Hide file tree

Showing 54 changed files with 356 additions and 1,270 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ However, a multi-user setup will benefit for a dedicated server.
 In this case, a docker image can be used
 
 ```bash
-$ docker run -p8080:8080 --env NVIDIA_DISABLE_REQUIRE=1 --gpus all fractalego/wafl-llm:latest
+$ docker run -p8080:8080 --env NVIDIA_DISABLE_REQUIRE=1 --gpus all fractalego/wafl-llm:0.80
 ```
 
 The interface side has a `config.json` file that needs to be filled with the IP address of the LLM side.

diff --git a/documentation/build/doctrees/directory_structure.doctree b/documentation/build/doctrees/directory_structure.doctree
diff --git a/documentation/build/doctrees/environment.pickle b/documentation/build/doctrees/environment.pickle
diff --git a/documentation/build/doctrees/examples.doctree b/documentation/build/doctrees/examples.doctree
diff --git a/documentation/build/doctrees/index.doctree b/documentation/build/doctrees/index.doctree
diff --git a/documentation/build/doctrees/introduction.doctree b/documentation/build/doctrees/introduction.doctree
diff --git a/documentation/build/doctrees/license.doctree b/documentation/build/doctrees/license.doctree
diff --git a/documentation/build/doctrees/rules.doctree b/documentation/build/doctrees/rules.doctree
diff --git a/documentation/build/doctrees/rules_and_backtracking.doctree b/documentation/build/doctrees/rules_and_backtracking.doctree
diff --git a/documentation/build/doctrees/wafl_init.doctree b/documentation/build/doctrees/wafl_init.doctree
diff --git a/documentation/build/html/_sources/directory_structure.rst.txt b/documentation/build/html/_sources/directory_structure.rst.txt
diff --git a/documentation/build/html/_sources/examples.rst.txt b/documentation/build/html/_sources/examples.rst.txt
@@ -4,5 +4,7 @@ Examples
 .. toctree::
    :maxdepth: 2
 
-   wafl_init
-   directory_structure
+   simple_rule
+   rule_with_examples
+   rules_with_execute_command
+   rules_with_remember_command
diff --git a/documentation/build/html/_sources/index.rst.txt b/documentation/build/html/_sources/index.rst.txt
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to WAFL's 0.0.45 documentation!
+Welcome to WAFL's 0.0.80 documentation!
 =======================================
 
 .. toctree::
@@ -12,9 +12,10 @@ Welcome to WAFL's 0.0.45 documentation!
 
    introduction
    installation
+   initialization
+   configuration
    running_WAFL
-   query_processing_pipeline
-   rules
+   facts_and_rules
    examples
    license
 

diff --git a/documentation/build/html/_sources/introduction.rst.txt b/documentation/build/html/_sources/introduction.rst.txt
@@ -5,8 +5,7 @@ WAFL is a framework for personal agents.
 It integrates Large language models, speech recognition and text to speech.
 
 This framework combines Large Language Models and rules to create a predictable behavior.
-Specifically, instead of organising the work of an LLM into a chain of thoughts,
-WAFL intends to organise its behavior into inference trees.
+A set of rules is used to define the behavior of the agent, supporting function calling and a working memory.
 
 WAFL is a work in progress.
 The current version requires the user to specify the rules to follow.

diff --git a/documentation/build/html/_sources/license.rst.txt b/documentation/build/html/_sources/license.rst.txt
@@ -3,7 +3,7 @@ License
 
 This software is licensed under the MIT License:
 
-Copyright (c) 2023 [email protected]
+Copyright (c) 2024 [email protected]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/documentation/build/html/_sources/rules.rst.txt b/documentation/build/html/_sources/rules.rst.txt
diff --git a/documentation/build/html/_sources/rules_and_backtracking.rst.txt b/documentation/build/html/_sources/rules_and_backtracking.rst.txt
diff --git a/documentation/build/html/_sources/wafl_init.rst.txt b/documentation/build/html/_sources/wafl_init.rst.txt
diff --git a/documentation/build/html/directory_structure.html b/documentation/build/html/directory_structure.html