Merge pull request #51 from Herb-AI/dev

Merge grammar updates to Master for publication

Project.toml

@@ -1,7 +1,7 @@
 name = "HerbGrammar"
 uuid = "4ef9e186-2fe5-4b24-8de7-9f7291f24af7"
 authors = ["Sebastijan Dumancic <[email protected]>", "Jaap de Jong <[email protected]>", "Nicolae Filat <[email protected]>", "Piotr Cichoń <[email protected]>"]
-version = "0.1.0"
+version = "0.2.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
@@ -11,11 +11,11 @@ TreeView = "39424ebd-4cf3-5550-a685-96706a953f40"
 HerbCore = "2b23ba43-8213-43cb-b5ea-38c12b45bd45"
 
 [compat]
-AbstractTrees = "0.4"
-DataStructures = "0.17,0.18"
-TreeView = "0.5"
-HerbCore = "0.1.0"
-julia = "1.8"
+AbstractTrees = "^0.4"
+DataStructures = "^0.18"
+TreeView = "^0.5"
+HerbCore = "^0.2.0"
+julia = "^1.8"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -1,11 +1,16 @@
-# Grammar.jl
 [![Build Status](https://github.com/Herb-AI/HerbGrammar.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/Herb-AI/HerbGrammar.jl/actions/workflows/CI.yml?query=branch%3Amaster)
+[![Dev-Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://Herb-AI.github.io/Herb.jl/dev)
+
+# HerbGrammar.jl
 
 This package contains functionality for declaring grammars for the Herb Program Synthesis framework.
 
+For full documentation please see the [`Herb.jl` documentation](https://herb-ai.github.io/Herb.jl/dev/).
+
 ## Getting started
-To use this project, initialize the project with 
+For a quick tutorial on how to get started with using `HerbSearch.jl` have a look at our [introductory tutorial](https://herb-ai.github.io/Herb.jl/dev/get_started/).
 
+If you want to help developing this project, initialize the project with 
 ```shell
 julia --project=. -e 'using Pkg; Pkg.instantiate()'
 ```

src/HerbGrammar.jl

@@ -12,10 +12,6 @@ include("rulenode_operators.jl")
 include("utils.jl")
 include("nodelocation.jl")
 
-
-include("cfg/cfg.jl")
-include("cfg/probabilistic_cfg.jl")
-
 include("csg/csg.jl")
 include("csg/probabilistic_csg.jl")
 
@@ -25,18 +21,13 @@ export
     ContextFree, 
     ContextSensitive,
 
-    ContextFreeGrammar,
-
     ContextSensitiveGrammar,
     AbstractRuleNode,
     RuleNode,
     Hole,
     NodeLoc,
 
-    ProbabilisticCFG,
-
     @cfgrammar,
-    expr2cfgrammar,
     max_arity,
     isterminal,
     iseval,
@@ -56,12 +47,11 @@ export
 
     @csgrammar,
     expr2csgrammar,
-    cfg2csg,
     clearconstraints!,
     addconstraint!,
+    merge_grammars!,
 
     @pcfgrammar,
-    expr2pcfgrammar,
 
     @pcsgrammar,
     expr2pcsgrammar,
@@ -77,9 +67,6 @@ export
     containedin,
     subsequenceof,
     has_children,
-    store_cfg,
-    read_cfg,
-    read_pcfg,
     store_csg,
     read_csg,
     read_pcsg,