Skip to content

Commit

Permalink
Added docs for new commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Khizov committed Sep 8, 2020
1 parent 64a186e commit a6b3345
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .typo-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,5 +172,7 @@ excluded_words:
- crfentityextractor
- Comerica
- entitysynonymmapper
- NLG
- nlg

spellcheck_filenames: false
30 changes: 24 additions & 6 deletions docs/docs/command-line-interface.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ The command line interface (CLI) gives you easy-to-remember commands for common
|`rasa visualize` |Visualizes stories. |
|`rasa test` |Tests a trained Rasa model using your test NLU data and stories. |
|`rasa data split nlu` |Performs a split of your NLU data according to the specified percentages. |
|`rasa data convert nlu` |Converts NLU training data between different formats. |
|`rasa data convert core` |Converts Core training data between different formats. |
|`rasa data convert nlg` |Converts NLG training data between different formats. |
|`rasa data convert` |Converts training data between different formats. |
|`rasa export` |Export conversations from a tracker store to an event broker. |
|`rasa x` |Launch Rasa X locally. |
|`rasa -h` |Shows all available commands. |
Expand Down Expand Up @@ -261,9 +259,9 @@ ls train_test_split
nlg_training_data.yml training_data.json
```

## rasa data convert
## rasa data convert nlu

You cam convert NLU data from
You can convert NLU data from
- LUIS data format,
- WIT data format,
- Dialogflow data format,
Expand All @@ -281,11 +279,31 @@ You can start the converter by running:
rasa data convert nlu
```

You can specify the input file, output file, and the output format with the following arguments:
You can specify the input file or directory, output file or directory, and the output format with the following arguments:

```text [rasa data convert nlu --help]
```

## rasa data convert core

You can convert Core data from Markdown to YAML.

You can specify the input file or directory, output directory with the following arguments:

```bash
rasa data convert core --help
```

## rasa data convert nlg

You can convert NLG data from Markdown to YAML.

You can specify the input file or directory, output directory with the following arguments:

```bash
rasa data convert nlg --help
```

## rasa export

To export events from a tracker store using an event broker, run:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ how you can migrate from one version to another.

### Training data files

You can convert existing NLU and Stories training data files in the `Markdown` format
to the new `YAML` format using following commands:
You can convert existing NLU, Stories, and NLG (i.e. `responses.md`) training data
files in the `Markdown` format to the new `YAML` format using following commands:

```bash
rasa data convert nlu -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}
Expand Down

0 comments on commit a6b3345

Please sign in to comment.