Update docs

biopragmatics · Mar 11, 2024 · 4ffafd1 · 4ffafd1
1 parent 001d3cf
commit 4ffafd1
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -5,3 +5,5 @@ Reference
 .. automodapi:: biomappings.utils
 
 .. automodapi:: biomappings.testing
+
+.. automodapi:: biomappings.resources
diff --git a/scripts/README.md b/scripts/README.md
@@ -0,0 +1,4 @@
+# Scripts
+
+This folder houses scripts that can be used to generate predicted mappings, typically
+through a lexical mapping workflow.
diff --git a/src/biomappings/resources/__init__.py b/src/biomappings/resources/__init__.py
@@ -27,6 +27,34 @@
 
 from biomappings.utils import OVERRIDE_MIRIAM, RESOURCE_PATH, get_canonical_tuple
 
+__all__ = [
+    "MappingTuple",
+    "MAPPINGS_HEADER",
+    "PredictionTuple",
+    "PREDICTIONS_HEADER",
+    "Mappings",
+    "load_mappings",
+    "load_mappings_subset",
+    "append_true_mappings",
+    "append_true_mapping_tuples",
+    "write_true_mappings",
+    "load_false_mappings",
+    "append_false_mappings",
+    "write_false_mappings",
+    "load_unsure",
+    "append_unsure_mappings",
+    "write_unsure_mappings",
+    "load_predictions",
+    "append_predictions",
+    "append_prediction_tuples",
+    "write_predictions",
+    "remove_mappings",
+    "load_curators",
+    "filter_predictions",
+    "get_curated_filter",
+    "prediction_tuples_from_semra",
+]
+
 logger = logging.getLogger(__name__)
 
 MAPPINGS_HEADER = [