CLI Commands
🚧 Under construction!
DeepNLPF Command Line Interface.
Help
deepnlpf -h
usage: deepnlpf [-h] [-v] [-install INSTALL] [-uninstall UNINSTALL] [-listplugins LISTPLUGINS] [-api API]
DeepNLPF Command Line Interface - CLI
optional arguments:
-h, --help show this help message and exit
-v, --version show version.
-install INSTALL, --install INSTALL
Command for install plugin.
-uninstall UNINSTALL, --uninstall UNINSTALL
Command for uninstall plugin.
-listplugins LISTPLUGINS, --listplugins LISTPLUGINS
Command for listplugins plugin.
-api API, --api API Command run api.
🐙 Enjoy the program! :)
Version
deepnlpf -v
🐙 DeepNLPF V x.x.x
Create project
deepnlpf --new [project_name] [json|yaml|ini|xml]
project_name
├── pipeline.py
├── custom_pipeline.json
└── README.md
Plugins
List all plugins published
deepnlpf --plugins published
cogcomp
stanfordcorenlp
spacy
semafor
supwsd
stanza
Install one plugin
deepnlpf --install [plugin_name]
stanfordcorenlp
stanza
List all plugins instaled
deepnlpf --plugins installed
stanfordcorenlp
stanza
Create new plugin
deepnlpf --new plugin [name_plugin]
/home/user_name/deepnlpf_data/name_plugin/
resources/
README.md
manifest.json
requeriments.sh
plugin_name.py
Dataset
Save new dataset
To save a dataset, it must be organized in one of the two directory structures shown below.
Simple structure
/home/your_user/path_dataset/
document_1.txt
document_2.txt
..
or Complete Structure
/home/your_user/path_dataset/
train/
pos/
document_01.txt
document_02.txt
..
neg/
document_01.txt
document_02.txt
..
test/
pos/
document_01.txt
document_02.txt
..
neg/
document_01.txt
document_02.txt
..
Sentences must be saved in the TXT file, one per line.
For the doc: document_1.txt You have the following sentences one after another.
1 A misty ridge uprises from the surge.
2 The author of a keygen uses a disassembler to look at the raw assembly code.
3 The child was carefully wrapped and bound into the cradle by means of a cord.
4 The system as described above has its greatest application in an arrayed configuration of antenna elements.
5 The student association is the vpath_oice of the undergraduate student population of the State University of New York at Buffalo.
You must use the command: deepnlpf --savedataset [path_dir_dataset] by passing the path of your dataset directory as an argument, as per the example below.
deepnlpf --savedataset /home/your_user/path_dataset/dataset_name
dataset: dataset_name
├── train:
│ └── documents [pos]: 100%|███████████████████████████████████████████████████| 12500/12500 [00:50<00:00, 245.24it/s]
│ └── documents [neg]: 100%|███████████████████████████████████████████████████| 12500/12500 [00:51<00:00, 241.78it/s]
├── test:
│ └── documents [pos]: 100%|███████████████████████████████████████████████████| 12500/12500 [00:59<00:00, 211.20it/s]
│ └── documents [neg]: 100%|███████████████████████████████████████████████████| 12500/12500 [01:01<00:00, 202.22it/s]
└── _id_dataset: 5d8f5e3825fc15b3ec6f43a6
List all datasets
Lists all dataset saved in the database.
deepnlpf --listdataset all
├── Dataset: dataset_name
│ ID: 5d8f55f4b3b87b4d30ee0445
│ Register: 2019-09-28 09:45:40.725000
├── Dataset: dataset_name
│ id_dataset: 5d8f576dd54e23a38cb3e819
│ register: 2019-09-28 09:51:57.850000
Delete one dataset
Used the command deepnlpf --deletedataset [_id_dataset] for delete a specific dataset.
deepnlpf --deletedataset 5d8f576dd54e23a38cb3e819
Pipeline
Run pipeline
Used the command deepnlpf --pipeline [custom_pipeline.json] for execute pipeline custom analises languagem.
deepnlpf --pipeline custom_pipeline.json
After running a custom analysis pipeline, all results are saved to the database.
View result analysis
Used the command deepnlf viewannotation [_id_dataset] for view annotation processing the dataset.
deepnlf --viewannotation 5d8ed3b6495308534096e879
Generated Annotation
deepnlf --generatedannotation [_id_pool_datset]
View annotation
deepnlpf --viewannotation [_id_pool_dataset]
Statistics
deepnlpf --statistics [dataset_name|dataset_id]
API
Start API
deepnlpf --start api
Stop API
Ctrl + c
DashBoard
Start DashBoard
deepnlpf --dashboard api
Stop DashBoard
Ctrl + c