added tutorial for search

Herb-AI · Jan 18, 2024 · b4934e3 · b4934e3
1 parent 35557bc
commit b4934e3
Show file tree

Hide file tree

Showing 4 changed files with 1,027 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -22,8 +22,9 @@ makedocs(;
             "concepts.md"
            ],
         "Tutorials" => [
-            "An more verbose getting started with Herb.jl" => "tutorials/getting_started_with_herb.md",
+            "A more verbose getting started with Herb.jl" => "tutorials/getting_started_with_herb.md",
             "Defining Grammars in Herb.jl" => "tutorials/defining_grammars.md"
+            "Advanced Search Procedures" => "tutorials/advanced_search.md"
         ],
         "Sub-Modules" => [
             "HerbGrammar.jl" => "HerbGrammar/index.md",

diff --git a/docs/src/HerbSearch/index.md b/docs/src/HerbSearch/index.md
@@ -9,6 +9,18 @@ Modules = [HerbSearch]
 Order   = [:type, :const, :macro, :function]
 ```
 
+The HerbSearch package takes care of all operations related to searching for the desired program. This includes
+- the functionality to sample a certain program given a grammar,
+- the implementation of several heuristic functions,
+- searching for a program that satisfies the specification, and
+- implementations of several search algorithms in terms of how they enumerate the search space
+  - Breadth-First Search 
+  - Depth-First Search 
+  - Metropolis Hastings 
+  - Very Large Scale Neighbourhood Search 
+  - Simulated Annealing
+  - Genetic Search
+
 ## Index
 
 ```@index