Use the Command-Line Interface# architxt# architxt Usage: architxt [OPTIONS] COMMAND [ARGS]... ArchiTXT is a tool for structuring textual data into a valid database model. It is guided by a meta-grammar and uses an iterative process of tree rewriting. ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--install-completionInstall completion for the current shell.│ │--show-completionShow completion for the current shell, to copy it or customize the│ │installation. │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ │ui Launch the web-based UI. │ │simplify Simplify a bunch of databased together. │ │corpus-stats Display overall statistics for the corpus. │ │largest-tree Display details about the largest tree in the corpus. │ │load │ │export │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ui# ui Usage: architxt ui [OPTIONS] Launch the web-based UI. ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ simplify# simplify Usage: architxt simplify [OPTIONS] FILES... Simplify a bunch of databased together. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*filesFILES...Path of the data files to load.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--tauFLOAT RANGE [0<=x<=1]The similarity threshold.[default: 0.7]│ │--epochINTEGER RANGE [x>=1]Number of iteration for tree rewriting.│ │[default: 100] │ │--min-supportINTEGER RANGE [x>=1]Minimum support for tree patterns.│ │[default: 20] │ │--sampleINTEGER RANGE [x>=1]Number of tree to use from the │ │simplification. │ │[default: None] │ │--workersINTEGER RANGE [x>=1]Number of parallel worker processes to │ │use. Defaults to the number of available│ │CPU cores. │ │[default: None] │ │--outputFILENAME Path to save the result.[default: None]│ │--shuffle--no-shuffleShuffle the data before processing to │ │introduce randomness. │ │[default: no-shuffle] │ │--debug--no-debugEnable debug mode for more verbose │ │output. │ │[default: no-debug] │ │--metrics--no-metricsShow metrics of the simplification.│ │[default: no-metrics] │ │--log--no-logEnable logging to MLFlow.│ │[default: no-log] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ corpus-stats# corpus-stats Usage: architxt corpus-stats [OPTIONS] CORPUS_PATH... Display overall statistics for the corpus. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*corpus_pathCORPUS_PATH...Path to the input corpus.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--languageTEXTLanguage of the input corpus.[default: French]│ │--corenlp-urlTEXTURL of the CoreNLP server.[default: http://localhost:9000]│ │--cache--no-cacheEnable caching of the analyzed corpus to prevent │ │re-parsing. │ │[default: cache] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ largest-tree# largest-tree Usage: architxt largest-tree [OPTIONS] CORPUS_PATH... Display details about the largest tree in the corpus. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*corpus_pathCORPUS_PATH...Path to the input corpus.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--languageTEXTLanguage of the input corpus.[default: French]│ │--corenlp-urlTEXTURL of the CoreNLP server.[default: http://localhost:9000]│ │--cache--no-cacheEnable caching of the analyzed corpus to prevent │ │re-parsing. │ │[default: cache] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ load# load Usage: architxt load [OPTIONS] COMMAND [ARGS]... ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ │document Extract information of a document file into a formatted tree. │ │database Extract the database information into a formatted tree. │ │corpus Extract a database schema form a corpus. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ document# document Usage: architxt load document [OPTIONS] FILE Extract information of a document file into a formatted tree. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*filePATHThe document file to read.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--raw--no-rawEnable row reading, skipping any transformation│ │to convert it to the metamodel. │ │[default: no-raw] │ │--root-nameTEXT The root node name.[default: ROOT]│ │--sampleINTEGER RANGE [x>=1]Number of sentences to sample from the corpus.│ │[default: None] │ │--outputFILENAME Path to save the result.[default: None]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ database# database Usage: architxt load database [OPTIONS] DB_CONNECTION Extract the database information into a formatted tree. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*db_connectionTEXTDatabase connection string.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--simplify-association--no-simplify-associ…Simplify association │ │tables. │ │[default: │ │simplify-association] │ │--sampleINTEGER RANGE [x>=1]Number of sentences to │ │sample from the corpus.│ │[default: None] │ │--outputFILENAME Path to save the │ │result. │ │[default: None] │ │--helpShow this message and │ │exit. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ corpus# corpus Usage: architxt load corpus [OPTIONS] CORPUS_PATH... Extract a database schema form a corpus. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*corpus_pathCORPUS_PATH...Path to the input corpus.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--languageTEXT Language of the input corpus.│ │[default: French] │ │--corenlp-urlTEXT URL of the CoreNLP server. │ │[default: http://localhost:9000]│ │--tauFLOAT RANGE [0<=x<=1]The similarity threshold.│ │[default: 0.7] │ │--epochINTEGER RANGE [x>=1]Number of iteration for tree │ │rewriting. │ │[default: 100] │ │--min-supportINTEGER RANGE [x>=1]Minimum support for tree patterns.│ │[default: 20] │ │--gen-instancesINTEGER RANGE [x>=0]Number of synthetic instances to │ │generate. │ │[default: 0] │ │--sampleINTEGER RANGE [x>=1]Number of sentences to sample from│ │the corpus. │ │[default: None] │ │--workersINTEGER RANGE [x>=1]Number of parallel worker │ │processes to use. Defaults to the │ │number of available CPU cores. │ │[default: None] │ │--resolver[umls|mesh|rxnorm|go|hpo]The entity resolver to use when │ │loading the corpus. │ │[default: None] │ │--outputFILENAME Path to save the result.│ │[default: None] │ │--cache--no-cacheEnable caching of the analyzed │ │corpus to prevent re-parsing. │ │[default: cache] │ │--shuffle--no-shuffleShuffle the corpus data before │ │processing to introduce │ │randomness. │ │[default: no-shuffle] │ │--debug--no-debugEnable debug mode for more verbose│ │output. │ │[default: no-debug] │ │--metrics--no-metricsShow metrics of the │ │simplification. │ │[default: no-metrics] │ │--log--no-logEnable logging to MLFlow.│ │[default: no-log] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ export# export Usage: architxt export [OPTIONS] COMMAND [ARGS]... ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ │graph Export the database to Cypher/Bolt compatible database such as Neo4j. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ graph# graph Usage: architxt export graph [OPTIONS] DATABASE... Export the database to Cypher/Bolt compatible database such as Neo4j. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*databaseDATABASE...Path to load the database.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │*--uriTEXTDatabase connection string.[default: None][required]│ │--usernameTEXTUsername to use for authentication.[default: neo4j]│ │--passwordTEXTPassword to use for authentication.[default: None]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯