aboutsummaryrefslogtreecommitdiff
path: root/tests/check_contextual_batch_parity.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/check_contextual_batch_parity.py')
-rwxr-xr-xtests/check_contextual_batch_parity.py15
1 files changed, 10 insertions, 5 deletions
diff --git a/tests/check_contextual_batch_parity.py b/tests/check_contextual_batch_parity.py
index 6cd7021..e7f1e94 100755
--- a/tests/check_contextual_batch_parity.py
+++ b/tests/check_contextual_batch_parity.py
@@ -1,11 +1,16 @@
#!/usr/bin/env python3
-"""Run the contextual batch-versus-singleton parity check.
+"""Run the contextual batch-vs-singleton parity check.
-The C side is tests/contextual_batch.c, built by the Makefile target
-`parity-context-driver`; this script builds it and runs it with the requested
-parameters. It compares the single-document path against the batched path in C
-(no external reference), so it needs a model directory but no Python ML stack.
+The C test is tests/contextual_batch.c, built by the Makefile target
+`parity-context-driver`.
+This script builds the driver and runs it with the requested parameters. It
+compares the single-document path against the batched path in C, with no
+external reference.
+
+Requires a model directory.
+
+Usage:
tests/check_contextual_batch_parity.py --model-dir DIR
"""