Merge pull request #196 from e-cal/document-techniques

Publicise extraction techniques' docs
AI-Planning · Jun 13, 2023 · 64b8ac4 · 64b8ac4
2 parents 3ba477d + 38d481d
commit 64b8ac4
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 3 deletions.
diff --git a/docs/templates/extract/extract.md b/docs/templates/extract/extract.md
@@ -17,6 +17,7 @@ _Note: debugging output and interfaces are unique to each method._
 - [SLAF](#slaf)
 - [ARMS](#arms)
 - [AMDN](#amdn)
+- [LOCM](#locm)
 
 .. include:: ../../../docs/templates/extract/observer.md
 
@@ -34,4 +35,8 @@ _Note: debugging output and interfaces are unique to each method._
 
 ---
 
+.. include:: ../../../docs/templates/extract/locm.md
+
+---
+
 # API Documentation
diff --git a/docs/templates/extract/locm.md b/docs/templates/extract/locm.md
@@ -0,0 +1 @@
+# LOCM
diff --git a/docs/templates/index.md b/docs/templates/index.md
@@ -17,5 +17,6 @@
 - [SLAF](macq/extract.html#slaf)
 - [ARMS](macq/extract.html#arms)
 - [AMDN](macq/extract.html#amdn)
+- [LOCM](macq/extract.html#locm)
 
 # API Documentation
diff --git a/macq/extract/__init__.py b/macq/extract/__init__.py
@@ -7,6 +7,11 @@
 from .extract import Extract, modes
 from .exceptions import IncompatibleObservationToken
 from .model import Model
+from .amdn import AMDN
+from .arms import ARMS
+from .locm import LOCM
+from .slaf import SLAF
+from .observer import Observer
 
 __all__ = [
     "LearnedAction",
@@ -17,4 +22,9 @@
     "Extract",
     "modes",
     "IncompatibleObservationToken",
+    "ARMS",
+    "AMDN",
+    "LOCM",
+    "SLAF",
+    "Observer",
 ]
diff --git a/macq/extract/extract.py b/macq/extract/extract.py
@@ -6,13 +6,13 @@
 
 from ..observation import ObservedTraceList
 from ..trace import Action, State
+from .model import Model
+
 from .amdn import AMDN
 from .arms import ARMS
 from .locm import LOCM
-from .model import Model
-from .observer import Observer
 from .slaf import SLAF
-
+from .observer import Observer
 
 @dataclass
 class SAS: