Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: rashidakanchwala <[email protected]>
  • Loading branch information
rashidakanchwala committed Nov 27, 2024
1 parent d905f15 commit 127b17c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
24 changes: 22 additions & 2 deletions docs/source/cli-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ kedro viz run [OPTIONS]
- Whether to open the Kedro Viz interface in the default browser. The browser will open if the host is `localhost`. Defaults to `True`.

- `--load-file <path>`
- Path to load Kedro Viz data from a directory. If provided, Kedro Viz will load the visualisation data from this path instead of generating it from the pipeline.
- Path to load Kedro Viz data from a [directory]((#kedro-viz-directory-structure-when-you-save-it-as-a-file). If provided, Kedro Viz will load the visualisation data from this path instead of generating it from the pipeline

- `--save-file <path>`
- Path to save Kedro Viz data to a directory. If provided, the visualisation data will be saved to this path for later use.
- Path to save Kedro Viz data to a [directory]((#kedro-viz-directory-structure-when-you-save-it-as-a-file). If provided, the visualisation data will be saved to this path for later use.

- `--pipeline, -p <pipeline>`
- Name of the registered pipeline to visualise. If not set, the default pipeline is visualised.
Expand Down Expand Up @@ -162,4 +162,24 @@ kedro viz build --include-previews
```


### Kedro-viz directory structure when you save it as a file

When you use the `--save-file` option, Kedro Viz generates a directory structure to save the visualization data. This directory can later be used with the `--load-file` to reload the visualization.

Check warning on line 167 in docs/source/cli-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/cli-docs.md#L167

[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
Raw output
{"message": "[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.", "location": {"path": "docs/source/cli-docs.md", "range": {"start": {"line": 167, "column": 94}}}, "severity": "WARNING"}

Check warning on line 167 in docs/source/cli-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/cli-docs.md#L167

[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.
Raw output
{"message": "[Kedro-viz.ukspelling] In general, use UK English spelling instead of 'visualization'.", "location": {"path": "docs/source/cli-docs.md", "range": {"start": {"line": 167, "column": 185}}}, "severity": "WARNING"}

The generated directory structure looks like this:

```bash
api/
├── main/
│ └── pipeline.json # Main file containing pipeline structure and metadata
├── nodes/
│ ├── node1.json # JSON files for individual nodes
│ ├── node2.json
│ └── ...
├── pipelines/
│ ├── pipeline1.json # JSON files for individual pipelines
│ ├── pipeline2.json
│ └── ...
```


4 changes: 2 additions & 2 deletions docs/source/kedro-viz_visualisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,8 @@ The `%run_viz` command supports various optional arguments found in `kedro viz r

* `--host=<host>`: Specify the server host.
* `--port=<port>`: Set the server port.
* `--load-file=<file>`: Load a specific pipeline visualisation file.
* `--save-file=<file>`: Save the current pipeline visualisation to a file.
* `--load-file=<file>`: Load a specific pipeline visualisation from a [directory](./cli-docs.md#kedro-viz-directory-structure-when-you-save-it-as-a-file).
* `--save-file=<file>`: Save the current pipeline visualisation to a [directory](./cli-docs.md#kedro-viz-directory-structure-when-you-save-it-as-a-file).
* `--pipeline=<name>`: Visualise a specific pipeline.
* `--env=<name>`: Set the environment for the visualisation.
* `--autoreload`: Enable automatic reloading of the visualisation when source code changes.
Expand Down

0 comments on commit 127b17c

Please sign in to comment.