standalone scripts

Signed-off-by: Elazar Gershuni <elazarg@gmail.com>

nakdimon/__init__.py

@@ -1 +1,119 @@
-from nakdimon.predict import predict as diacritize
+import argparse
+import sys
+import os
+import logging
+
+
+def do_train(**kwargs) -> None:
+    from nakdimon import train
+    train.main(**kwargs)
+
+
+def do_run_test(**kwargs) -> None:
+    from nakdimon import run_test
+    run_test.main(**kwargs)
+
+
+def do_metrics(**kwargs) -> None:
+    from nakdimon import metrics
+    metrics.main(**kwargs)
+
+
+def do_predict(**kwargs) -> None:
+    from nakdimon import predict
+    predict.main(**kwargs)
+
+
+def do_server(**kwargs):
+    import os
+    import sys
+    import pkgutil
+    package = pkgutil.get_loader("server")
+    assert package is not None
+    logging.info("Executing flask server...")
+    os.execv(sys.executable, [sys.executable, package.get_filename()])
+    exit(1)
+
+
+def main() -> None:
+    logging.basicConfig(level=logging.INFO, format='%(levelname)s - %(message)s')
+
+    # Parse command line arguments
+    parser = argparse.ArgumentParser(
+        description="""Train and evaluate Nakdimon and other diacritizers. Reproduce the Nakdimon paper.""",
+    )
+    parser.add_argument('-q', '--quiet', action='store_true', help='suppress info logging.', default=False)
+
+    subparsers = parser.add_subparsers(help='sub-command help', dest="command", required=True)
+
+    parser_train = subparsers.add_parser('train', help='train Nakdimon')
+    parser_train.add_argument('--wandb', action='store_true', help='use wandb.', default=False)
+    parser_train.add_argument('--model', help='path to output model (.h5 file)', default='models/Full.h5', dest='model_path')
+    parser_train.add_argument('--ablation', help='ablation test', default=None, dest='ablation_name')
+    parser_train.set_defaults(func=do_train)
+
+    test_systems = ['Snopi', 'Morfix', 'Dicta', 'Nakdimon', 'MajMod', 'MajAllWithDicta', 'MajAllWithoutDicta']
+    # iterate over folders to find available options:
+    available_tests = [f'tests/{folder}' for folder in os.listdir('tests/')
+                       if os.path.isdir(f'tests/{folder}') and os.path.isdir(f'tests/{folder}/expected')]
+
+    parser_test = subparsers.add_parser('run_test', help='diacritize a test set')
+    parser_test.add_argument('--test_set', choices=available_tests, help='choose test set', default='tests/new')
+    parser_test.add_argument('--system', choices=test_systems, help='diacritization system to use', default='Nakdimon')
+    parser_test.add_argument('--model', help='path to model (.h5 file)', default='models/Nakdimon.h5', dest='model_path')
+    parser_test.add_argument('--skip-existing', action='store_true', help='skip existing files')
+    parser_test.set_defaults(func=do_run_test)
+
+    parser_predict = subparsers.add_parser('predict', help='diacritize a text file')
+    parser_predict.add_argument('input_path', help='input file')
+    parser_predict.add_argument('output_path', help='output file')
+    parser_predict.set_defaults(func=do_predict)
+
+    # parser_daemon = subparsers.add_parser('server', help='run Nakdimon server as a daemon')
+    # parser_daemon.set_defaults(func=do_server)
+
+    parser_eval = subparsers.add_parser('results', help='evaluate the results of a test run')
+    parser_eval.add_argument('--test_set', choices=available_tests, help='choose test set', default='tests/new')
+    partial_result, _ = parser.parse_known_args()
+    if partial_result.command == 'results':
+        test_systems = [folder for folder in os.listdir(partial_result.test_set)
+                        if os.path.isdir(f'{partial_result.test_set}/{folder}') and folder != 'expected']
+    parser_eval.add_argument('--systems', choices=test_systems, nargs='+', help='list of systems to evaluate',
+                             default=test_systems)
+    parser_eval.set_defaults(func=do_metrics)
+
+    args = parser.parse_args()
+
+    if args.quiet:
+        logging.disable(logging.INFO)
+    del args.quiet
+
+    kwargs = vars(args).copy()
+    del kwargs['command']
+    del kwargs['func']
+    args.func(**kwargs)
+
+    sys.exit(0)
+
+
+def diacritize_main():
+    import argparse
+    import pathlib
+    import sys
+    parser = argparse.ArgumentParser(description="""Diacritize Hebrew text.""")
+    parser.add_argument('input_path', help='input file')
+    parser.add_argument('-o', help='output file', default="-")
+    args = parser.parse_args()
+
+    if not pathlib.Path(args.input_path).exists():
+        print(f"File not found: '{args.input_path}'", file=sys.stderr)
+        sys.exit(1)
+
+    import nakdimon.predict
+    nakdimon.predict.main(args.input_path, args.o)
+    sys.exit(0)
+
+
+def diacritize(text: str, model_path: str = 'models/Nakdimon.h5') -> str:
+    import nakdimon.predict
+    return nakdimon.predict.predict(text, model_path)

nakdimon/__main__.py

@@ -1,99 +1,4 @@
-import argparse
-import sys
-import os
-import logging
-
-
-def do_train(**kwargs) -> None:
-    from nakdimon import train
-    train.main(**kwargs)
-
-
-def do_run_test(**kwargs) -> None:
-    from nakdimon import run_test
-    run_test.main(**kwargs)
-
-
-def do_metrics(**kwargs) -> None:
-    from nakdimon import metrics
-    metrics.main(**kwargs)
-
-
-def do_predict(**kwargs) -> None:
-    from nakdimon import predict
-    predict.main(**kwargs)
-
-
-def do_server(**kwargs):
-    import os
-    import sys
-    import pkgutil
-    package = pkgutil.get_loader("server")
-    assert package is not None
-    logging.info("Executing flask server...")
-    os.execv(sys.executable, [sys.executable, package.get_filename()])
-    exit(1)
-
-
-def main() -> None:
-    logging.basicConfig(level=logging.INFO, format='%(levelname)s - %(message)s')
-
-    # Parse command line arguments
-    parser = argparse.ArgumentParser(
-        description="""Train and evaluate Nakdimon and other diacritizers. Reproduce the Nakdimon paper.""",
-    )
-    parser.add_argument('-q', '--quiet', action='store_true', help='suppress info logging.', default=False)
-
-    subparsers = parser.add_subparsers(help='sub-command help', dest="command", required=True)
-
-    parser_train = subparsers.add_parser('train', help='train Nakdimon')
-    parser_train.add_argument('--wandb', action='store_true', help='use wandb.', default=False)
-    parser_train.add_argument('--model', help='path to output model (.h5 file)', default='models/Full.h5', dest='model_path')
-    parser_train.add_argument('--ablation', help='ablation test', default=None, dest='ablation_name')
-    parser_train.set_defaults(func=do_train)
-
-    test_systems = ['Snopi', 'Morfix', 'Dicta', 'Nakdimon', 'MajMod', 'MajAllWithDicta', 'MajAllWithoutDicta']
-    # iterate over folders to find available options:
-    available_tests = [f'tests/{folder}' for folder in os.listdir('tests/')
-                       if os.path.isdir(f'tests/{folder}') and os.path.isdir(f'tests/{folder}/expected')]
-
-    parser_test = subparsers.add_parser('run_test', help='diacritize a test set')
-    parser_test.add_argument('--test_set', choices=available_tests, help='choose test set', default='tests/new')
-    parser_test.add_argument('--system', choices=test_systems, help='diacritization system to use', default='Nakdimon')
-    parser_test.add_argument('--model', help='path to model (.h5 file)', default='models/Nakdimon.h5', dest='model_path')
-    parser_test.add_argument('--skip-existing', action='store_true', help='skip existing files')
-    parser_test.set_defaults(func=do_run_test)
-
-    parser_predict = subparsers.add_parser('predict', help='diacritize a text file')
-    parser_predict.add_argument('input_path', help='input file')
-    parser_predict.add_argument('output_path', help='output file')
-    parser_predict.set_defaults(func=do_predict)
-
-    # parser_daemon = subparsers.add_parser('server', help='run Nakdimon server as a daemon')
-    # parser_daemon.set_defaults(func=do_server)
-
-    parser_eval = subparsers.add_parser('results', help='evaluate the results of a test run')
-    parser_eval.add_argument('--test_set', choices=available_tests, help='choose test set', default='tests/new')
-    partial_result, _ = parser.parse_known_args()
-    if partial_result.command == 'results':
-        test_systems = [folder for folder in os.listdir(partial_result.test_set)
-                        if os.path.isdir(f'{partial_result.test_set}/{folder}') and folder != 'expected']
-    parser_eval.add_argument('--systems', choices=test_systems, nargs='+', help='list of systems to evaluate',
-                             default=test_systems)
-    parser_eval.set_defaults(func=do_metrics)
-
-    args = parser.parse_args()
-
-    if args.quiet:
-        logging.disable(logging.INFO)
-    del args.quiet
-
-    kwargs = vars(args).copy()
-    del kwargs['command']
-    del kwargs['func']
-    args.func(**kwargs)
-
-    sys.exit(0)
 
 if __name__ == '__main__':
-    main()
+    import nakdimon
+    nakdimon.main()

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nakdimon"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
   { name="Elazar Gershuni", email="elazarg@gmail.com" },
 ]
@@ -33,4 +33,5 @@ namespaces = false
 "Bug Tracker" = "https://github.com/elazarg/nakdimon/issues"
 
 [project.scripts]
-nakdimon = 'main:main'
+nakdimon = 'nakdimon:main'
+diacritize = 'nakdimon:diacritize_main'