Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document python version policies and other small doc updates. #2139

Merged
merged 3 commits into from
Oct 14, 2024
Merged

Document python version policies and other small doc updates. #2139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c562bd8
done
rashidakanchwala Oct 14, 2024
15690ce
Update kedro-viz_visualisation.md
rashidakanchwala Oct 14, 2024
37e24e1
Merge branch 'main' into doc-readme-updates
rashidakanchwala Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 22 additions & 12 deletions docs/source/kedro-viz_visualisation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ If you haven't installed Kedro {doc}`follow the documentation to get set up<kedr
We recommend that you use the same version of Kedro that was most recently used to test this tutorial (0.19.0). To check the version installed, type `kedro -V` in your terminal window.
```

Once you have installed Kedro, you can install Kedro-viz

```bash
pip install kedro-viz
```

```{note}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one makes it wrapped around the code block. Is it intended?

Screenshot 2024-10-14 at 11 29 12

Do we not want it to be in the "note block" instead?

> **Note:** This is a note block in a Markdown file.

Copy link
Contributor Author

@rashidakanchwala rashidakanchwala Oct 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't render correctly there but it does here - https://kedro--2139.org.readthedocs.build/projects/kedro-viz/en/2139/kedro-viz_visualisation.html

[Kedro Viz](https://github.com/kedro-org/kedro-viz) supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from Kedro-viz. This is not considered a breaking change.
```

In your terminal window, navigate to the folder you want to store the project. Generate the spaceflights tutorial project with all the code in place by using the [Kedro starter for the spaceflights tutorial](https://github.com/kedro-org/kedro-starters/tree/main/spaceflights-pandas):


Expand All @@ -29,25 +39,15 @@ The next step is optional, but useful to check that all is working. Run the full
```bash
kedro run
```
Kedro-Viz provides stats related to datasets under the metadata panel

![](./images/pipeline_dataset_stats.png)

These stats are generated by hooks. If you have Kedro-Viz installed and execute `kedro run`, the hooks will generate the stats by default. To disable this, you can disable Kedro-Viz hooks in the settings file of your project.

```{note}
Starting from Kedro-Viz 9.2.0, the dataset stats file `stats.json` will be moved to `.viz` directory at the root of your Kedro project in-case you have `kedro-viz` installed and had not disabled hooks for `kedro-viz` plugin.
```

To start Kedro-Viz, type the following into your terminal from the project directory:

```bash
kedro viz run
```

```{important}
The former `kedro viz` command used here is now deprecated with the release of Kedro-Viz 7.0.0.
`kedro viz run` is now the new way to run the tool.
```{note}
You can also type `kedro viz` to start Kedro-viz
```

The command opens a browser tab to serve the visualisation at `http://127.0.0.1:4141/`.
Expand All @@ -63,6 +63,16 @@ If a visualisation panel opens up and a pipeline is not visible, refresh the vie

To exit the visualisation, close the browser tab. To regain control of the terminal, enter `^+c` on Mac or `Ctrl+c` on Windows or Linux machines.

Kedro-Viz provides stats related to datasets under the metadata panel

![](./images/pipeline_dataset_stats.png)

These stats are generated by hooks. If you have Kedro-Viz installed and execute `kedro run`, the hooks will generate the stats by default. To disable this, you can disable Kedro-Viz hooks in the settings file of your project.

```{note}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here with the code block style

Screenshot 2024-10-14 at 11 31 37

Starting from Kedro-Viz 9.2.0, the dataset stats file `stats.json` will be moved to `.viz` directory at the root of your Kedro project in-case you have `kedro-viz` installed and had not disabled hooks for `kedro-viz` plugin.
```

## Visualise a Kedro project without installing project dependencies

You can use the experimental `--lite` flag to visualise your pipelines without installing Kedro project dependencies. Add the flag to the command you use to start Kedro-Viz:
Expand Down
11 changes: 5 additions & 6 deletions package/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,17 +283,16 @@

## Feature Flags

Kedro-Viz uses features flags to roll out some experimental features. The following flags are currently in use:

| Flag | Description |
| ------------------ | --------------------------------------------------------------------------------------- |
| sizewarning | From release v3.9.1. Show a warning before rendering very large graphs (default `true`) |
| expandAllPipelines | From release v4.3.2. Expand all modular pipelines on first load (default `false`) |
Kedro-Viz uses features flags to roll out some experimental features. No feature flags are currently in use.

Check warning on line 286 in package/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] package/README.md#L286 

[Kedro-viz.weaselwords] 'currently' is a weasel word!
Raw output 
{"message": "[Kedro-viz.weaselwords] 'currently' is a weasel word!", "location": {"path": "package/README.md", "range": {"start": {"line": 286, "column": 92}}}, "severity": "WARNING"}

To enable or disable a flag, click on the settings icon in the toolbar and toggle the flag on/off.

Kedro-Viz also logs a message in your browser's [developer console](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#The_JavaScript_console) to show the available flags and their values as currently set on your machine.


## Python version support policy
Kedro Viz supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from Kedro-viz. This is not considered a breaking change.

Check warning on line 294 in package/README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] package/README.md#L294 

[Kedro-viz.Spellings] Did you really mean 'CPython'?
Raw output 
{"message": "[Kedro-viz.Spellings] Did you really mean 'CPython'?", "location": {"path": "package/README.md", "range": {"start": {"line": 294, "column": 76}}}, "severity": "WARNING"}

## Maintainers

Kedro-Viz is maintained by the [Kedro team](https://docs.kedro.org/en/stable/contribution/technical_steering_committee.html#kedro-maintainers) and a number of [contributors from across the world](https://github.com/kedro-org/Kedro-Viz/contributors).
Expand Down
Loading