-
Notifications
You must be signed in to change notification settings - Fork 41
/
cli.py
795 lines (713 loc) · 26.9 KB
/
cli.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
"""Definitions for command-line (Click) commands for invoking Annif
operations and printing the results to console."""
import collections
import importlib
import json
import os.path
import re
import sys
import click
import click_log
from flask.cli import FlaskGroup
import annif
import annif.corpus
import annif.parallel
import annif.project
import annif.registry
from annif import cli_util, hfh_util
from annif.exception import (
NotInitializedException,
NotSupportedException,
OperationFailedException,
)
from annif.project import Access
from annif.simplemma_util import detect_language
from annif.util import metric_code
logger = annif.logger
click_log.basic_config(logger)
create_app = annif.create_flask_app
cli = FlaskGroup(
create_app=create_app, add_default_commands=False, add_version_option=False
)
cli = click.version_option(message="%(version)s")(cli)
cli.params = [opt for opt in cli.params if opt.name not in ("env_file", "app")]
@cli.command("list-projects")
@cli_util.common_options
@click_log.simple_verbosity_option(logger, default="ERROR")
def run_list_projects():
"""
List available projects.
\f
Show a list of currently defined projects. Projects are defined in a
configuration file, normally called ``projects.cfg``. See `Project
configuration
<https://github.com/NatLibFi/Annif/wiki/Project-configuration>`_
for details.
"""
column_headings = (
"Project ID",
"Project Name",
"Vocabulary ID",
"Language",
"Trained",
"Modification time",
)
table = [
(
proj.project_id,
proj.name,
proj.vocab.vocab_id if proj.vocab_spec else "-",
proj.language,
str(proj.is_trained),
cli_util.format_datetime(proj.modification_time),
)
for proj in annif.registry.get_projects(min_access=Access.private).values()
]
template = cli_util.make_list_template(column_headings, *table)
header = template.format(*column_headings)
click.echo(header)
click.echo("-" * len(header))
for row in table:
click.echo(template.format(*row))
@cli.command("show-project")
@cli_util.project_id
@cli_util.common_options
def run_show_project(project_id):
"""
Show information about a project.
"""
proj = cli_util.get_project(project_id)
click.echo(f"Project ID: {proj.project_id}")
click.echo(f"Project Name: {proj.name}")
click.echo(f"Language: {proj.language}")
click.echo(f"Vocabulary: {proj.vocab.vocab_id}")
click.echo(f"Vocab language: {proj.vocab_lang}")
click.echo(f"Access: {proj.access.name}")
click.echo(f"Backend: {proj.backend.name}")
click.echo(f"Trained: {proj.is_trained}")
click.echo(f"Modification time: {cli_util.format_datetime(proj.modification_time)}")
@cli.command("clear")
@cli_util.project_id
@cli_util.common_options
def run_clear_project(project_id):
"""
Initialize the project to its original, untrained state.
"""
proj = cli_util.get_project(project_id)
proj.remove_model_data()
@cli.command("list-vocabs")
@cli_util.common_options
@click_log.simple_verbosity_option(logger, default="ERROR")
def run_list_vocabs():
"""
List available vocabularies.
"""
column_headings = ("Vocabulary ID", "Languages", "Size", "Loaded")
table = []
for vocab in annif.registry.get_vocabs(min_access=Access.private).values():
try:
languages = ",".join(sorted(vocab.languages))
size = len(vocab)
loaded = True
except NotInitializedException:
languages = "-"
size = "-"
loaded = False
row = (vocab.vocab_id, languages, str(size), str(loaded))
table.append(row)
template = cli_util.make_list_template(column_headings, *table)
header = template.format(*column_headings)
click.echo(header)
click.echo("-" * len(header))
for row in table:
click.echo(template.format(*row))
@cli.command("load-vocab")
@click.argument("vocab_id", shell_complete=cli_util.complete_param)
@click.argument("subjectfile", type=click.Path(exists=True, dir_okay=False))
@click.option("--language", "-L", help="Language of subject file")
@click.option(
"--force",
"-f",
default=False,
is_flag=True,
help="Replace existing vocabulary completely instead of updating it",
)
@cli_util.common_options
def run_load_vocab(vocab_id, language, force, subjectfile):
"""
Load a vocabulary from a subject file.
"""
vocab = cli_util.get_vocab(vocab_id)
if annif.corpus.SubjectFileSKOS.is_rdf_file(subjectfile):
# SKOS/RDF file supported by rdflib
subjects = annif.corpus.SubjectFileSKOS(subjectfile)
click.echo(f"Loading vocabulary from SKOS file {subjectfile}...")
elif annif.corpus.SubjectFileCSV.is_csv_file(subjectfile):
# CSV file
subjects = annif.corpus.SubjectFileCSV(subjectfile)
click.echo(f"Loading vocabulary from CSV file {subjectfile}...")
else:
# probably a TSV file - we need to know its language
if not language:
click.echo(
"Please use --language option to set the language of a TSV vocabulary.",
err=True,
)
sys.exit(1)
click.echo(f"Loading vocabulary from TSV file {subjectfile}...")
subjects = annif.corpus.SubjectFileTSV(subjectfile, language)
vocab.load_vocabulary(subjects, force=force)
@cli.command("train")
@cli_util.project_id
@click.argument("paths", type=click.Path(exists=True), nargs=-1)
@click.option(
"--cached/--no-cached",
"-c/-C",
default=False,
help="Reuse preprocessed training data from previous run",
)
@click.option(
"--jobs",
"-j",
default=0,
help="Number of parallel jobs (0 means choose automatically)",
)
@cli_util.docs_limit_option
@cli_util.backend_param_option
@cli_util.common_options
def run_train(project_id, paths, cached, docs_limit, jobs, backend_param):
"""
Train a project on a collection of documents.
\f
This will train the project using the documents from ``PATHS`` (directories
or possibly gzipped TSV files) in a single batch operation. If ``--cached``
is set, preprocessed training data from the previous run is reused instead
of documents input; see `Reusing preprocessed training data
<https://github.com/NatLibFi/Annif/wiki/
Reusing-preprocessed-training-data>`_.
"""
proj = cli_util.get_project(project_id)
backend_params = cli_util.parse_backend_params(backend_param, proj)
if cached:
if len(paths) > 0:
raise click.UsageError(
"Corpus paths cannot be given when using --cached option."
)
documents = "cached"
else:
documents = cli_util.open_documents(
paths, proj.subjects, proj.vocab_lang, docs_limit
)
proj.train(documents, backend_params, jobs)
@cli.command("learn")
@cli_util.project_id
@click.argument("paths", type=click.Path(exists=True), nargs=-1)
@cli_util.docs_limit_option
@cli_util.backend_param_option
@cli_util.common_options
def run_learn(project_id, paths, docs_limit, backend_param):
"""
Further train an existing project on a collection of documents.
\f
Similar to the ``train`` command. This will continue training an already
trained project using the documents given by ``PATHS`` in a single batch
operation. Not supported by all backends.
"""
proj = cli_util.get_project(project_id)
backend_params = cli_util.parse_backend_params(backend_param, proj)
documents = cli_util.open_documents(
paths, proj.subjects, proj.vocab_lang, docs_limit
)
proj.learn(documents, backend_params)
@cli.command("suggest")
@cli_util.project_id
@click.argument(
"paths", type=click.Path(dir_okay=False, exists=True, allow_dash=True), nargs=-1
)
@click.option("--limit", "-l", default=10, help="Maximum number of subjects")
@click.option("--threshold", "-t", default=0.0, help="Minimum score threshold")
@click.option("--language", "-L", help="Language of subject labels")
@cli_util.docs_limit_option
@cli_util.backend_param_option
@cli_util.common_options
def run_suggest(
project_id, paths, limit, threshold, language, backend_param, docs_limit
):
"""
Suggest subjects for a single document from standard input or for one or more
document file(s) given its/their path(s).
\f
This will read a text document from standard input and suggest subjects for
it, or if given path(s) to file(s), suggest subjects for it/them.
"""
project = cli_util.get_project(project_id)
lang = language or project.vocab_lang
if lang not in project.vocab.languages:
raise click.BadParameter(f'language "{lang}" not supported by vocabulary')
backend_params = cli_util.parse_backend_params(backend_param, project)
if paths and not (len(paths) == 1 and paths[0] == "-"):
docs = cli_util.open_text_documents(paths, docs_limit)
results = project.suggest_corpus(docs, backend_params).filter(limit, threshold)
for (
suggestions,
path,
) in zip(results, paths):
click.echo(f"Suggestions for {path}")
cli_util.show_hits(suggestions, project, lang)
else:
text = sys.stdin.read()
suggestions = project.suggest([text], backend_params).filter(limit, threshold)[
0
]
cli_util.show_hits(suggestions, project, lang)
@cli.command("index")
@cli_util.project_id
@click.argument("directory", type=click.Path(exists=True, file_okay=False))
@click.option(
"--suffix", "-s", default=".annif", help="File name suffix for result files"
)
@click.option(
"--force/--no-force",
"-f/-F",
default=False,
help="Force overwriting of existing result files",
)
@click.option("--limit", "-l", default=10, help="Maximum number of subjects")
@click.option("--threshold", "-t", default=0.0, help="Minimum score threshold")
@click.option("--language", "-L", help="Language of subject labels")
@cli_util.backend_param_option
@cli_util.common_options
def run_index(
project_id, directory, suffix, force, limit, threshold, language, backend_param
):
"""
Index a directory with documents, suggesting subjects for each document.
Write the results in TSV files with the given suffix (``.annif`` by
default).
"""
project = cli_util.get_project(project_id)
lang = language or project.vocab_lang
if lang not in project.vocab.languages:
raise click.BadParameter(f'language "{lang}" not supported by vocabulary')
backend_params = cli_util.parse_backend_params(backend_param, project)
documents = annif.corpus.DocumentDirectory(directory, require_subjects=False)
results = project.suggest_corpus(documents, backend_params).filter(limit, threshold)
for (docfilename, _), suggestions in zip(documents, results):
subjectfilename = re.sub(r"\.txt$", suffix, docfilename)
if os.path.exists(subjectfilename) and not force:
click.echo(
"Not overwriting {} (use --force to override)".format(subjectfilename)
)
continue
with open(subjectfilename, "w", encoding="utf-8") as subjfile:
cli_util.show_hits(suggestions, project, lang, file=subjfile)
@cli.command("eval")
@cli_util.project_id
@click.argument("paths", type=click.Path(exists=True), nargs=-1)
@click.option("--limit", "-l", default=10, help="Maximum number of subjects")
@click.option("--threshold", "-t", default=0.0, help="Minimum score threshold")
@click.option(
"--metric",
"-m",
default=[],
multiple=True,
help="Metric to calculate (default: all)",
)
@click.option(
"--metrics-file",
"-M",
type=click.File("w", encoding="utf-8", errors="ignore", lazy=True),
help="""Specify file in order to write evaluation metrics in JSON format.
File directory must exist, existing file will be overwritten.""",
)
@click.option(
"--results-file",
"-r",
type=click.File("w", encoding="utf-8", errors="ignore", lazy=True),
help="""Specify file in order to write non-aggregated results per subject.
File directory must exist, existing file will be overwritten.""",
)
@click.option(
"--jobs", "-j", default=1, help="Number of parallel jobs (0 means all CPUs)"
)
@cli_util.docs_limit_option
@cli_util.backend_param_option
@cli_util.common_options
def run_eval(
project_id,
paths,
limit,
threshold,
docs_limit,
metric,
metrics_file,
results_file,
jobs,
backend_param,
):
"""
Suggest subjects for documents and evaluate the results by comparing
against a gold standard.
\f
With this command the documents from ``PATHS`` (directories or possibly
gzipped TSV files) will be assigned subject suggestions and then
statistical measures are calculated that quantify how well the suggested
subjects match the gold-standard subjects in the documents.
Normally the output is the list of the metrics calculated across documents.
If ``--results-file <FILENAME>`` option is given, the metrics are
calculated separately for each subject, and written to the given file.
"""
project = cli_util.get_project(project_id)
backend_params = cli_util.parse_backend_params(backend_param, project)
import annif.eval
eval_batch = annif.eval.EvaluationBatch(project.subjects)
if results_file:
try:
print("", end="", file=results_file)
click.echo(
"Writing per subject evaluation results to {!s}".format(
results_file.name
)
)
except Exception as e:
raise NotSupportedException(
"cannot open results-file for writing: " + str(e)
)
corpus = cli_util.open_documents(
paths, project.subjects, project.vocab_lang, docs_limit
)
jobs, pool_class = annif.parallel.get_pool(jobs)
project.initialize(parallel=True)
psmap = annif.parallel.ProjectSuggestMap(
project.registry, [project_id], backend_params, limit, threshold
)
with pool_class(jobs) as pool:
for hit_sets, subject_sets in pool.imap_unordered(
psmap.suggest_batch, corpus.doc_batches
):
eval_batch.evaluate_many(hit_sets[project_id], subject_sets)
template = "{0:<30}\t{1:{fmt_spec}}"
metrics = eval_batch.results(
metrics=metric, results_file=results_file, language=project.vocab_lang
)
for metric, score in metrics.items():
if isinstance(score, int):
fmt_spec = "d"
elif isinstance(score, float):
fmt_spec = ".04f"
click.echo(template.format(metric + ":", score, fmt_spec=fmt_spec))
if metrics_file:
json.dump(
{metric_code(mname): val for mname, val in metrics.items()},
metrics_file,
indent=2,
)
@cli.command("run")
@click.option("--host", type=str, default="127.0.0.1")
@click.option("--port", type=int, default=5000)
@click.option("--log-level")
@click_log.simple_verbosity_option(logger, default="ERROR")
def run_app(**kwargs):
"""
Run Annif in server mode for development.
\f
The server is for development purposes only.
"""
kwargs = {k: v for k, v in kwargs.items() if v is not None}
cxapp = annif.create_cx_app()
cxapp.run(**kwargs)
FILTER_BATCH_MAX_LIMIT = 15
OPTIMIZE_METRICS = ["Precision (doc avg)", "Recall (doc avg)", "F1 score (doc avg)"]
@cli.command("optimize")
@cli_util.project_id
@click.argument("paths", type=click.Path(exists=True), nargs=-1)
@click.option(
"--jobs", "-j", default=1, help="Number of parallel jobs (0 means all CPUs)"
)
@cli_util.docs_limit_option
@cli_util.backend_param_option
@cli_util.common_options
def run_optimize(project_id, paths, jobs, docs_limit, backend_param):
"""
Suggest subjects for documents, testing multiple limits and thresholds.
\f
This command will use different limit (maximum number of subjects) and
score threshold values when assigning subjects to each document given by
``PATHS`` and compare the results against the gold standard subjects in the
documents. The output is a list of parameter combinations and their scores.
From the output, you can determine the optimum limit and threshold
parameters depending on which measure you want to target.
"""
project = cli_util.get_project(project_id)
backend_params = cli_util.parse_backend_params(backend_param, project)
filter_params = cli_util.generate_filter_params(FILTER_BATCH_MAX_LIMIT)
import annif.eval
corpus = cli_util.open_documents(
paths, project.subjects, project.vocab_lang, docs_limit
)
jobs, pool_class = annif.parallel.get_pool(jobs)
project.initialize(parallel=True)
psmap = annif.parallel.ProjectSuggestMap(
project.registry,
[project_id],
backend_params,
limit=FILTER_BATCH_MAX_LIMIT,
threshold=0.0,
)
ndocs = 0
suggestion_batches = []
subject_set_batches = []
with pool_class(jobs) as pool:
for suggestion_batch, subject_sets in pool.imap_unordered(
psmap.suggest_batch, corpus.doc_batches
):
ndocs += len(suggestion_batch[project_id])
suggestion_batches.append(suggestion_batch[project_id])
subject_set_batches.append(subject_sets)
from annif.suggestion import SuggestionResults
orig_suggestion_results = SuggestionResults(suggestion_batches)
click.echo("\t".join(("Limit", "Thresh.", "Prec.", "Rec.", "F1")))
best_scores = collections.defaultdict(float)
best_params = {}
template = "{:d}\t{:.02f}\t{:.04f}\t{:.04f}\t{:.04f}"
import annif.eval
for limit, threshold in filter_params:
eval_batch = annif.eval.EvaluationBatch(project.subjects)
filtered_results = orig_suggestion_results.filter(limit, threshold)
for batch, subject_sets in zip(filtered_results.batches, subject_set_batches):
eval_batch.evaluate_many(batch, subject_sets)
results = eval_batch.results(metrics=OPTIMIZE_METRICS)
for metric, score in results.items():
if score >= best_scores[metric]:
best_scores[metric] = score
best_params[metric] = (limit, threshold)
click.echo(
template.format(
limit,
threshold,
results["Precision (doc avg)"],
results["Recall (doc avg)"],
results["F1 score (doc avg)"],
)
)
click.echo()
template2 = "Best {:>19}: {:.04f}\tLimit: {:d}\tThreshold: {:.02f}"
for metric in OPTIMIZE_METRICS:
click.echo(
template2.format(
metric,
best_scores[metric],
best_params[metric][0],
best_params[metric][1],
)
)
click.echo("Documents evaluated:\t{}".format(ndocs))
@cli.command("hyperopt")
@cli_util.project_id
@click.argument("paths", type=click.Path(exists=True), nargs=-1)
@click.option("--trials", "-T", default=10, help="Number of trials")
@click.option(
"--jobs", "-j", default=1, help="Number of parallel runs (0 means all CPUs)"
)
@click.option(
"--metric", "-m", default="NDCG", help="Metric to optimize (default: NDCG)"
)
@click.option(
"--results-file",
"-r",
type=click.File("w", encoding="utf-8", errors="ignore", lazy=True),
help="""Specify file path to write trial results as CSV.
File directory must exist, existing file will be overwritten.""",
)
@cli_util.docs_limit_option
@cli_util.common_options
def run_hyperopt(project_id, paths, docs_limit, trials, jobs, metric, results_file):
"""
Optimize the hyperparameters of a project using validation documents from
``PATHS``. Not supported by all backends. Output is a list of trial results
and a report of the best performing parameters.
"""
proj = cli_util.get_project(project_id)
documents = cli_util.open_documents(
paths, proj.subjects, proj.vocab_lang, docs_limit
)
click.echo(f"Looking for optimal hyperparameters using {trials} trials")
rec = proj.hyperopt(documents, trials, jobs, metric, results_file)
click.echo(f"Got best {metric} score {rec.score:.4f} with:")
click.echo("---")
for line in rec.lines:
click.echo(line)
click.echo("---")
@cli.command("upload")
@click.argument("project_ids_pattern", shell_complete=cli_util.complete_param)
@click.argument("repo_id")
@click.option(
"--token",
help="""Authentication token, obtained from the Hugging Face Hub.
Will default to the stored token.""",
)
@click.option(
"--revision",
help="""An optional git revision to commit from. Defaults to the head of the "main"
branch.""",
)
@click.option(
"--commit-message",
help="""The summary / title / first line of the generated commit.""",
)
@click.option(
"--modelcard/--no-modelcard",
default=True,
help="Update or create a Model Card with upload.",
)
@cli_util.common_options
def run_upload(
project_ids_pattern, repo_id, token, revision, commit_message, modelcard
):
"""
Upload selected projects and their vocabularies to a Hugging Face Hub repository.
\f
This command zips the project directories and vocabularies of the projects
that match the given `project_ids_pattern` to archive files, and uploads the
archives along with the project configurations to the specified Hugging Face
Hub repository. An authentication token and commit message can be given with
options. If the README.md does not exist in the repository it is
created with default contents and metadata of the uploaded projects, if it exists,
its metadata are updated as necessary.
"""
from huggingface_hub import HfApi
from huggingface_hub.utils import HfHubHTTPError, HFValidationError
projects = hfh_util.get_matching_projects(project_ids_pattern)
click.echo(f"Uploading project(s): {', '.join([p.project_id for p in projects])}")
commit_message = (
commit_message
if commit_message is not None
else f"Upload project(s) {project_ids_pattern} with Annif"
)
fobjs, operations = [], []
try:
fobjs, operations = hfh_util.prepare_commits(projects, repo_id, token)
api = HfApi()
api.create_commit(
repo_id=repo_id,
operations=operations,
commit_message=commit_message,
revision=revision,
token=token,
)
except (HfHubHTTPError, HFValidationError) as err:
raise OperationFailedException(str(err))
else:
if modelcard:
hfh_util.upsert_modelcard(repo_id, projects, token, revision)
finally:
for fobj in fobjs:
fobj.close()
@cli.command("download")
@click.argument("project_ids_pattern")
@click.argument("repo_id")
@click.option(
"--token",
help="""Authentication token, obtained from the Hugging Face Hub.
Will default to the stored token.""",
)
@click.option(
"--revision",
help="""
An optional Git revision id which can be a branch name, a tag, or a commit
hash.
""",
)
@click.option(
"--force",
"-f",
default=False,
is_flag=True,
help="Replace an existing project/vocabulary/config with the downloaded one",
)
@click.option(
"--trust-repo",
default=False,
is_flag=True,
help="Allow download from the repository even when it has no entries in the cache",
)
@cli_util.common_options
def run_download(project_ids_pattern, repo_id, token, revision, force, trust_repo):
"""
Download selected projects and their vocabularies from a Hugging Face Hub
repository.
\f
This command downloads the project and vocabulary archives and the
configuration files of the projects that match the given
`project_ids_pattern` from the specified Hugging Face Hub repository and
unzips the archives to `data/` directory and places the configuration files
to `projects.d/` directory. An authentication token and revision can be given with
options. If the repository hasn’t been used for downloads previously
(i.e., it doesn’t appear in the Hugging Face Hub cache on local system), the
`--trust-repo` option needs to be used.
"""
hfh_util.check_is_download_allowed(trust_repo, repo_id)
project_ids = hfh_util.get_matching_project_ids_from_hf_hub(
project_ids_pattern, repo_id, token, revision
)
click.echo(f"Downloading project(s): {', '.join(project_ids)}")
vocab_ids = set()
for project_id in project_ids:
project_zip_cache_path = hfh_util.download_from_hf_hub(
f"projects/{project_id}.zip", repo_id, token, revision
)
hfh_util.unzip_archive(project_zip_cache_path, force)
config_file_cache_path = hfh_util.download_from_hf_hub(
f"{project_id}.cfg", repo_id, token, revision
)
vocab_ids.add(hfh_util.get_vocab_id_from_config(config_file_cache_path))
hfh_util.copy_project_config(config_file_cache_path, force)
for vocab_id in vocab_ids:
vocab_zip_cache_path = hfh_util.download_from_hf_hub(
f"vocabs/{vocab_id}.zip", repo_id, token, revision
)
hfh_util.unzip_archive(vocab_zip_cache_path, force)
@cli.command("completion")
@click.option("--bash", "shell", flag_value="bash")
@click.option("--zsh", "shell", flag_value="zsh")
@click.option("--fish", "shell", flag_value="fish")
def run_completion(shell):
"""Generate the script for tab-key autocompletion for the given shell. To enable the
completion support in your current bash terminal session run\n
source <(annif completion --bash)
"""
if shell is None:
raise click.UsageError("Shell not given, try --bash, --zsh or --fish")
script = os.popen(f"_ANNIF_COMPLETE={shell}_source annif").read()
click.echo(f"# Generated by Annif {importlib.metadata.version('annif')}")
click.echo(script)
@cli.command("detect-language")
@click.argument("languages")
@click.argument(
"paths", type=click.Path(dir_okay=False, exists=True, allow_dash=True), nargs=-1
)
def run_detect_language(languages, paths):
"""
Detect the language of a single text document from standard input or for one or more
document file(s) given its/their path(s).
"""
langs = tuple(languages.split(","))
def detect_language_and_show(text, languages):
try:
proportions = detect_language(text, languages)
except ValueError as e:
raise click.UsageError(e)
for lang, score in proportions.items():
if lang == "unk":
lang = "?"
click.echo(f"{lang}\t{score:.04f}")
if paths and not (len(paths) == 1 and paths[0] == "-"):
doclist = cli_util.open_text_documents(paths, docs_limit=None)
for doc, path in zip(doclist.documents, paths):
click.echo(f"Detected languages for {path}")
detect_language_and_show(doc.text, langs)
else:
text = sys.stdin.read()
detect_language_and_show(text, langs)
if __name__ == "__main__":
cli()