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. │ │inspect Display statistics of a dataset. │ │generate Generate synthetic instance. │ │cache-clear Clear all the cache of ArchiTXT │ │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] │ │--workersINTEGER RANGE [x>=1]Number of parallel worker processes to │ │use. Defaults to the number of available│ │CPU cores. │ │[default: None] │ │--outputPATH Path to save the result.[default: None]│ │--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.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ inspect# inspect Usage: architxt inspect [OPTIONS] FILES... Display statistics of a dataset. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*filesFILES...Path of the data files to load.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ generate# generate Usage: architxt generate [OPTIONS] Generate synthetic instance. ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--sampleINTEGER RANGE [x>=1]Number of sentences to sample from the corpus.│ │[default: 100] │ │--outputPATH Path to save the result.[default: None]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ cache-clear# cache-clear Usage: architxt cache-clear [OPTIONS] Clear all the cache of ArchiTXT ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--force--no-forceForce the deletion of the cache without asking.[default: no-force]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ load# load Usage: architxt load [OPTIONS] COMMAND [ARGS]... ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮ │document Extract document database into a formatted tree. │ │sql Extract a SQL compatible database into a formatted tree. │ │graph Extract a cypher/bolt compatible database into a formatted tree. │ │corpus Extract a database schema form a corpus. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ document# document Usage: architxt load document [OPTIONS] FILE Extract document database 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 element to sample │ │from the document. │ │[default: None] │ │--outputPATH Path to save the result.│ │[default: None] │ │--merge-existing--no-merge-existingShould we merge data if output │ │file already exist │ │[default: no-merge-existing] │ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ sql# sql Usage: architxt load sql [OPTIONS] URI Extract a SQL compatible database into a formatted tree. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*uriTEXTDatabase 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] │ │--outputPATH Path to save the │ │result. │ │[default: None] │ │--merge-existing--no-merge-existingShould we merge data if│ │output file already │ │exist │ │[default: │ │no-merge-existing] │ │--helpShow this message and │ │exit. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ graph# graph Usage: architxt load graph [OPTIONS] URI Extract a cypher/bolt compatible database into a formatted tree. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*uriTEXTDatabase connection string.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │--usernameTEXT Username to use for │ │authentication. │ │[default: neo4j] │ │--passwordTEXT Password to use for │ │authentication. │ │[default: None] │ │--sampleINTEGER RANGE [x>=1]Number of sentences to sample │ │from the corpus. │ │[default: None] │ │--outputPATH Path to save the result.│ │[default: None] │ │--merge-existing--no-merge-existingShould we merge data if output │ │file already exist │ │[default: no-merge-existing] │ │--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] │ │--sampleINTEGER RANGE [x>=1]Number of sentences to │ │sample from the corpus. │ │[default: None] │ │--resolver[umls|mesh|rxnorm|go|hpo]The entity resolver to use│ │when loading the corpus. │ │[default: None] │ │--outputPATH Path to save the result.│ │[default: None] │ │--merge-existing--no-merge-existingShould we merge data if │ │output file already exist │ │[default: │ │no-merge-existing] │ │--cache--no-cacheEnable caching of the │ │analyzed corpus to prevent│ │re-parsing. │ │[default: cache] │ │--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. │ │sql Export the database to SQL compatible database. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ 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.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ sql# sql Usage: architxt export sql [OPTIONS] DATABASE... Export the database to SQL compatible database. ╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────╮ │*databaseDATABASE...Path to load the database.[default: None][required]│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮ │*--uriTEXTDatabase connection string.[default: None][required]│ │--helpShow this message and exit.│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
