new: Feedback to console on artefact paths

Author: ivyleavedtoadflax

deep_reference_parser/parse.py

@@ -33,6 +33,8 @@ def __init__(self, config_file):
 
         cfg = get_config(config_file)
 
+        msg.info(f"Attempting to download model artefacts if they are not found locally in {cfg['build']['output_path']}. This may take some time...")
+
         # Build config
 
         OUTPUT_PATH = cfg["build"]["output_path"]
@@ -138,7 +140,8 @@ def parse(self, text, verbose=False):
 def parse(text, config_file=PARSER_CFG, outfile=None):
     """
     Runs the default parsing model and pretty prints results to console unless
-    --outfile is parsed with a path.
+    --outfile is parsed with a path. Output written to the the path specified in
+    --outfile will be a valid json.
 
     NOTE: that this function is provided for examples only and should not be used
     in production as the model is instantiated each time the command is run. To

deep_reference_parser/split.py

@@ -37,6 +37,8 @@ def __init__(self, config_file):
 
         cfg = get_config(config_file)
 
+        msg.info(f"Attempting to download model artefacts if they are not found locally in {cfg['build']['output_path']}. This may take some time...")
+
         # Build config
 
         OUTPUT_PATH = cfg["build"]["output_path"]
@@ -172,7 +174,8 @@ def split(self, text, return_tokens=False, verbose=False):
 def split(text, config_file=SPLITTER_CFG, tokens=False, outfile=None):
     """
     Runs the default splitting model and pretty prints results to console unless
-    --outfile is parsed with a path. Can output either tokens (with -t|--tokens)
+    --outfile is parsed with a path. Files output to the path specified in
+    --outfile will be a valid json. Can output either tokens (with -t|--tokens)
     or split naively into references based on the b-r tag (default).
 
     NOTE: that this function is provided for examples only and should not be used