diff --git a/docs/source/_static/css/qb1-sphinx-rtd.css b/docs/source/_static/css/qb1-sphinx-rtd.css index 84837339cc..3d01a657b8 100644 --- a/docs/source/_static/css/qb1-sphinx-rtd.css +++ b/docs/source/_static/css/qb1-sphinx-rtd.css @@ -150,6 +150,10 @@ body.wy-body-for-nav { background: none !important; } +.wy-menu-vertical li.toctree-l1>a { + font-size: 1.8rem; +} + .rst-content.style-external-links a.reference.external:after { color: inherit; opacity: 0.8; @@ -259,6 +263,7 @@ body.wy-body-for-nav { .wy-body-for-nav .wy-menu-vertical li.current a:hover { background: none; + font-weight: 600; } .wy-menu-vertical a span.toctree-expand { diff --git a/docs/source/configuration/index.md b/docs/source/configuration/index.md new file mode 100644 index 0000000000..3f554e1e91 --- /dev/null +++ b/docs/source/configuration/index.md @@ -0,0 +1,10 @@ +# Configuration + +```{toctree} +:maxdepth: 1 + +configuration_basics +credentials +parameters +advanced_configuration +``` diff --git a/docs/source/contribution/contribute_to_kedro.md b/docs/source/contribution/index.md similarity index 82% rename from docs/source/contribution/contribute_to_kedro.md rename to docs/source/contribution/index.md index 2695589711..c8a89b6a2d 100644 --- a/docs/source/contribution/contribute_to_kedro.md +++ b/docs/source/contribution/index.md @@ -1,4 +1,4 @@ -# Introduction +# Contribute to Kedro We welcome any and all contributions to Kedro, at whatever level you can manage. For example, you could: @@ -10,3 +10,14 @@ We welcome any and all contributions to Kedro, at whatever level you can manage. - [Review other contributors' PRs](https://github.com/kedro-org/kedro/pulls) - [Contribute code](./developer_contributor_guidelines.md), for example to fix a bug or add a feature - [Contribute to the documentation](documentation_contributor_guidelines.md) + + +```{toctree} +:hidden: + +developer_contributor_guidelines +backwards_compatibility +documentation_contributor_guidelines +technical_steering_committee +development_for_databricks +``` diff --git a/docs/source/data/index.md b/docs/source/data/index.md new file mode 100644 index 0000000000..00c05353fc --- /dev/null +++ b/docs/source/data/index.md @@ -0,0 +1,8 @@ +# Data Catalog + +```{toctree} +:maxdepth: 1 + +data_catalog +kedro_io +``` diff --git a/docs/source/deployment/deployment_guide.md b/docs/source/deployment/index.md similarity index 91% rename from docs/source/deployment/deployment_guide.md rename to docs/source/deployment/index.md index 468c8ff375..d711aea3e9 100644 --- a/docs/source/deployment/deployment_guide.md +++ b/docs/source/deployment/index.md @@ -1,4 +1,4 @@ -# Deployment guide +# Deployment ## Deployment choices @@ -33,3 +33,20 @@ flowchart TD H["Does (part of) your pipeline integrate with Amazon SageMaker?

Read the SageMaker integration guide"]; style H text-align:left ``` + +## Deployment guides + +```{toctree} +:maxdepth: 1 + +single_machine +distributed +argo +prefect +kubeflow +aws_batch +aws_sagemaker +aws_step_functions +airflow_astronomer +dask +``` diff --git a/docs/source/development/index.md b/docs/source/development/index.md new file mode 100644 index 0000000000..ccdeeecbfc --- /dev/null +++ b/docs/source/development/index.md @@ -0,0 +1,12 @@ +# Development + +```{toctree} +:maxdepth: 1 + +set_up_vscode +set_up_pycharm +commands_reference +debugging +automated_testing +linting +``` diff --git a/docs/source/extend_kedro/index.md b/docs/source/extend_kedro/index.md new file mode 100644 index 0000000000..f368ac9a73 --- /dev/null +++ b/docs/source/extend_kedro/index.md @@ -0,0 +1,9 @@ +# Extend Kedro + +```{toctree} +:maxdepth: 1 + +common_use_cases +custom_datasets +plugins +``` diff --git a/docs/source/get_started/index.md b/docs/source/get_started/index.md new file mode 100644 index 0000000000..59e5ae38e5 --- /dev/null +++ b/docs/source/get_started/index.md @@ -0,0 +1,11 @@ +# First steps + +This section explains the first steps to set up and explore Kedro: + +```{toctree} +:maxdepth: 1 + +install +new_project +kedro_concepts +``` diff --git a/docs/source/get_started/install.md b/docs/source/get_started/install.md index 753056dffd..0ce17301c5 100644 --- a/docs/source/get_started/install.md +++ b/docs/source/get_started/install.md @@ -1,14 +1,5 @@ # Set up Kedro -## Summary - -* Kedro can be used on Windows, macOS or Linux. -* Installation prerequisites include a virtual environment manager like `conda`, Python 3.7+, and `git`. -* You should install Kedro using `pip install kedro`. - -If you encounter any problems as you set up Kedro, ask for help on Kedro's [Slack organisation](https://slack.kedro.org) or review the [searchable archive of Slack discussions](https://www.linen.dev/s/kedro). - - ## Installation prerequisites * **Python**: Kedro supports macOS, Linux, and Windows and is built for Python 3.7+. You'll select a version of Python when you create a virtual environment for your Kedro project. @@ -189,3 +180,11 @@ If you want to roll back to a stable version of Kedro, execute the following in pip uninstall kedro -y pip install kedro ``` + +## Summary + +* Kedro can be used on Windows, macOS or Linux. +* Installation prerequisites include a virtual environment manager like `conda`, Python 3.7+, and `git`. +* You should install Kedro using `pip install kedro`. + +If you encounter any problems as you set up Kedro, ask for help on Kedro's [Slack organisation](https://slack.kedro.org) or review the [searchable archive of Slack discussions](https://www.linen.dev/s/kedro). diff --git a/docs/source/hooks/index.md b/docs/source/hooks/index.md new file mode 100644 index 0000000000..74f819c3e0 --- /dev/null +++ b/docs/source/hooks/index.md @@ -0,0 +1,18 @@ +# Hooks + + +## Introduction + +Hooks are a mechanism to add extra behaviour to Kedro's main execution in an easy and consistent manner. Some examples might include: + +* Adding a log statement after the data catalog is loaded. +* Adding data validation to the inputs before a node runs, and to the outputs after a node has run. This makes it possible to integrate with other tools like [Great-Expectations](https://docs.greatexpectations.io/en/latest/). +* Adding machine learning metrics tracking, e.g. using [MLflow](https://mlflow.org/), throughout a pipeline run. + +```{toctree} +:maxdepth: 1 + +introduction +common_use_cases +examples +``` diff --git a/docs/source/hooks/introduction.md b/docs/source/hooks/introduction.md index 741c194f58..297b8be44f 100644 --- a/docs/source/hooks/introduction.md +++ b/docs/source/hooks/introduction.md @@ -1,13 +1,5 @@ # Hooks -## Introduction - -Hooks are a mechanism to add extra behaviour to Kedro's main execution in an easy and consistent manner. Some examples might include: - -* Adding a log statement after the data catalog is loaded -* Adding data validation to the inputs before a node runs, and to the outputs after a node has run. This makes it possible to integrate with other tools like [Great-Expectations](https://docs.greatexpectations.io/en/latest/) -* Adding machine learning metrics tracking, e.g. using [MLflow](https://mlflow.org/), throughout a pipeline run - ## Concepts A Hook consists of a Hook specification, and Hook implementation. To add Hooks to your project, you must: diff --git a/docs/source/index.rst b/docs/source/index.rst index 7cf13db285..bbda085210 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -53,157 +53,90 @@ Welcome to Kedro's documentation! .. toctree:: :maxdepth: 2 - :caption: Introduction + :caption: Learn about Kedro - introduction/introduction + introduction/index.md .. toctree:: :maxdepth: 2 - :caption: First steps - get_started/install - get_started/new_project - get_started/kedro_concepts + get_started/index.md .. toctree:: :maxdepth: 2 - :caption: Next steps: Tutorial + :caption: Tutorial and basic Kedro usage - tutorial/spaceflights_tutorial - tutorial/tutorial_template - tutorial/set_up_data - tutorial/create_a_pipeline - tutorial/add_another_pipeline - tutorial/package_a_project - tutorial/spaceflights_tutorial_faqs + tutorial/spaceflights_tutorial.md .. toctree:: :maxdepth: 2 - :caption: Visualisation with Kedro-Viz - visualisation/kedro-viz_visualisation - visualisation/visualise_charts_with_plotly - visualisation/experiment_tracking + visualisation/index.md .. toctree:: :maxdepth: 2 - :caption: Notebooks & IPython users - notebooks_and_ipython/kedro_and_notebooks - notebooks_and_ipython/kedro_as_a_data_registry + notebooks_and_ipython/index.md + resources/index.md .. toctree:: :maxdepth: 2 - :caption: Kedro project setup + :caption: Kedro projects - kedro_project_setup/starters - kedro_project_setup/dependencies - kedro_project_setup/session - kedro_project_setup/settings + kedro_project_setup/index.md .. toctree:: :maxdepth: 2 - :caption: Configuration - configuration/configuration_basics - configuration/credentials - configuration/parameters - configuration/advanced_configuration + configuration/index.md .. toctree:: :maxdepth: 2 - :caption: Data Catalog - data/data_catalog - data/kedro_io + data/index.md .. toctree:: :maxdepth: 2 - :caption: Nodes and pipelines - nodes_and_pipelines/nodes - nodes_and_pipelines/pipeline_introduction - nodes_and_pipelines/modular_pipelines - nodes_and_pipelines/pipeline_registry - nodes_and_pipelines/micro_packaging - nodes_and_pipelines/run_a_pipeline - nodes_and_pipelines/slice_a_pipeline + nodes_and_pipelines/index.md .. toctree:: :maxdepth: 2 - :caption: Extend Kedro + :caption: Advanced usage - extend_kedro/common_use_cases - extend_kedro/custom_datasets - extend_kedro/plugins + extend_kedro/index.md .. toctree:: :maxdepth: 2 - :caption: Hooks - hooks/introduction - hooks/common_use_cases - hooks/examples + hooks/index.md .. toctree:: :maxdepth: 2 - :caption: Logging - logging/logging + logging/index.md .. toctree:: :maxdepth: 2 - :caption: Integrations - integrations/databricks.rst - integrations/pyspark.rst + integrations/index.md .. toctree:: :maxdepth: 2 - :caption: Development - development/set_up_vscode - development/set_up_pycharm - development/commands_reference - development/debugging - development/automated_testing - development/linting + development/index.md .. toctree:: :maxdepth: 2 - :caption: Deployment - - deployment/deployment_guide - deployment/single_machine - deployment/distributed - deployment/argo - deployment/prefect - deployment/kubeflow - deployment/aws_batch - deployment/aws_sagemaker - deployment/aws_step_functions - deployment/airflow_astronomer - deployment/dask - -.. toctree:: - :maxdepth: 2 - :caption: Resources - - faq/faq - resources/glossary + deployment/index.md .. toctree:: :maxdepth: 2 :caption: Contribute to Kedro - contribution/contribute_to_kedro - contribution/developer_contributor_guidelines - contribution/backwards_compatibility - contribution/documentation_contributor_guidelines - contribution/technical_steering_committee - contribution/development_for_databricks + contribution/index.md API documentation ================= diff --git a/docs/source/integrations/databricks.md b/docs/source/integrations/databricks.md deleted file mode 100644 index 32523578a0..0000000000 --- a/docs/source/integrations/databricks.md +++ /dev/null @@ -1,9 +0,0 @@ -# Databricks integration - -```{toctree} -:caption: Databricks -:maxdepth: 2 - -databricks_workspace.md -databricks_visualisation.md -``` diff --git a/docs/source/integrations/index.md b/docs/source/integrations/index.md new file mode 100644 index 0000000000..d6da745882 --- /dev/null +++ b/docs/source/integrations/index.md @@ -0,0 +1,20 @@ +# Integrations + + +## Databricks integration + +```{toctree} +:maxdepth: 1 + +databricks_workspace.md +databricks_visualisation.md +``` + + +## PySpark integration + +```{toctree} +:maxdepth: 1 + +pyspark_integration.md +``` diff --git a/docs/source/integrations/pyspark.md b/docs/source/integrations/pyspark.md deleted file mode 100644 index 19c3e4b39c..0000000000 --- a/docs/source/integrations/pyspark.md +++ /dev/null @@ -1,8 +0,0 @@ -# PySpark integration - -```{toctree} -:caption: PySpark -:maxdepth: 2 - -pyspark_integration.md -``` diff --git a/docs/source/introduction/index.md b/docs/source/introduction/index.md new file mode 100644 index 0000000000..dee8eaeee3 --- /dev/null +++ b/docs/source/introduction/index.md @@ -0,0 +1,10 @@ +# Introduction to Kedro + +```{toctree} +:hidden: +introduction +``` + +Kedro is an open-source Python framework to create reproducible, maintainable, and modular data science code. It uses software engineering best practices to help you build production-ready data science pipelines. + +Kedro is hosted by the [LF AI & Data Foundation](https://lfaidata.foundation/), and you can find the [Kedro source code on GitHub](https://github.com/kedro-org/kedro). diff --git a/docs/source/introduction/introduction.md b/docs/source/introduction/introduction.md index 6bb0ad4fa4..45fea38bd2 100644 --- a/docs/source/introduction/introduction.md +++ b/docs/source/introduction/introduction.md @@ -1,10 +1,4 @@ -# What is Kedro? - -Kedro is an open-source Python framework to create reproducible, maintainable, and modular data science code. It uses software engineering best practices to help you build production-ready data science pipelines. - -Kedro is hosted by the [LF AI & Data Foundation](https://lfaidata.foundation/), and you can find the [Kedro source code on GitHub](https://github.com/kedro-org/kedro). - -## Learn how to use Kedro +# Learn how to use Kedro In the following chapters, you will learn [how to set up Kedro](../get_started/install.md) and discover the [key Kedro concepts](../get_started/kedro_concepts.md). You can then review the [spaceflights tutorial](../tutorial/tutorial_template.md) to get hands-on experience with a Kedro project. diff --git a/docs/source/kedro_project_setup/index.md b/docs/source/kedro_project_setup/index.md new file mode 100644 index 0000000000..2b3f882950 --- /dev/null +++ b/docs/source/kedro_project_setup/index.md @@ -0,0 +1,10 @@ +# Kedro project setup + +```{toctree} +:maxdepth: 1 + +starters +dependencies +session +settings +``` diff --git a/docs/source/logging/index.md b/docs/source/logging/index.md new file mode 100644 index 0000000000..a3750bb188 --- /dev/null +++ b/docs/source/logging/index.md @@ -0,0 +1,19 @@ +# Logging + + +Kedro uses [Python's `logging` library](https://docs.python.org/3/library/logging.html). Configuration is provided as a dictionary according to the [Python logging configuration schema](https://docs.python.org/3/library/logging.config.html#logging-config-dictschema) in two places: +1. [Default configuration built into the Kedro framework](https://github.com/kedro-org/kedro/blob/main/kedro/framework/project/default_logging.yml). This cannot be altered. +2. Your project-side logging configuration. Every project generated using Kedro's CLI `kedro new` command includes a file `conf/base/logging.yml`. You can alter this configuration and provide different configurations for different run environment according to the [standard Kedro mechanism for handling configuration](../configuration/configuration_basics.md). + +```{note} +Providing project-side logging configuration is entirely optional. You can delete the `conf/base/logging.yml` file and Kedro will run using the framework's built in configuration. +``` + +Framework-side and project-side logging configuration are loaded through subsequent calls to [`logging.config.dictConfig`](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig). This means that, when it is provided, the project-side logging configuration typically _fully overwrites_ the framework-side logging configuration. [Incremental configuration](https://docs.python.org/3/library/logging.config.html#incremental-configuration) is also possible if the `incremental` key is explicitly set to `True` in your project-side logging configuration. + + +```{toctree} +:hidden: + +logging +``` diff --git a/docs/source/logging/logging.md b/docs/source/logging/logging.md index cac0aac5cd..d8ed0bd61f 100644 --- a/docs/source/logging/logging.md +++ b/docs/source/logging/logging.md @@ -1,16 +1,5 @@ -# Logging -Kedro uses [Python's `logging` library](https://docs.python.org/3/library/logging.html). Configuration is provided as a dictionary according to the [Python logging configuration schema](https://docs.python.org/3/library/logging.config.html#logging-config-dictschema) in two places: -1. [Default configuration built into the Kedro framework](https://github.com/kedro-org/kedro/blob/main/kedro/framework/project/default_logging.yml). This cannot be altered. -2. Your project-side logging configuration. Every project generated using Kedro's CLI `kedro new` command includes a file `conf/base/logging.yml`. You can alter this configuration and provide different configurations for different run environment according to the [standard Kedro mechanism for handling configuration](../configuration/configuration_basics.md). - -```{note} -Providing project-side logging configuration is entirely optional. You can delete the `conf/base/logging.yml` file and Kedro will run using the framework's built in configuration. -``` - -Framework-side and project-side logging configuration are loaded through subsequent calls to [`logging.config.dictConfig`](https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig). This means that, when it is provided, the project-side logging configuration typically _fully overwrites_ the framework-side logging configuration. [Incremental configuration](https://docs.python.org/3/library/logging.config.html#incremental-configuration) is also possible if the `incremental` key is explicitly set to `True` in your project-side logging configuration. - -## Default framework-side logging configuration +# Default framework-side logging configuration Kedro's [default logging configuration](https://github.com/kedro-org/kedro/blob/main/kedro/framework/project/default_logging.yml) defines a handler called `rich` that uses the [Rich logging handler](https://rich.readthedocs.io/en/stable/logging.html) to format messages. We also use the [Rich traceback handler](https://rich.readthedocs.io/en/stable/traceback.html) to render exceptions. diff --git a/docs/source/nodes_and_pipelines/index.md b/docs/source/nodes_and_pipelines/index.md new file mode 100644 index 0000000000..893b100fc3 --- /dev/null +++ b/docs/source/nodes_and_pipelines/index.md @@ -0,0 +1,13 @@ +# Nodes and pipelines + +```{toctree} +:maxdepth: 1 + +nodes +pipeline_introduction +modular_pipelines +pipeline_registry +micro_packaging +run_a_pipeline +slice_a_pipeline +``` diff --git a/docs/source/notebooks_and_ipython/index.md b/docs/source/notebooks_and_ipython/index.md new file mode 100644 index 0000000000..ae6516c055 --- /dev/null +++ b/docs/source/notebooks_and_ipython/index.md @@ -0,0 +1,12 @@ +# Kedro for notebook users + + +You can take advantage of a notebook's liberal development environment for exploratory data analysis and experimentation from within a Kedro project. Later, when you need to follow software best practices as the project complexity increases, or as you scale into production, you can transfer code from the notebook into Kedro to benefit from its opinionated project framework. + + +```{toctree} +:maxdepth: 1 + +kedro_and_notebooks +kedro_as_a_data_registry +``` diff --git a/docs/source/notebooks_and_ipython/kedro_and_notebooks.md b/docs/source/notebooks_and_ipython/kedro_and_notebooks.md index d31572b51d..6e6ca31ec5 100644 --- a/docs/source/notebooks_and_ipython/kedro_and_notebooks.md +++ b/docs/source/notebooks_and_ipython/kedro_and_notebooks.md @@ -1,7 +1,5 @@ # Kedro and Jupyter Notebooks -You can take advantage of a Jupyter Notebook's liberal development environment for exploratory data analysis and experimentation from within a Kedro project. Later, when you need to follow software best practices as the project complexity increases, or as you scale into production, you can transfer code from the Notebook into Kedro to benefit from its opinionated project framework. - This page explains how best to combine Kedro and Jupyter Notebook development and illustrates with an example Notebook that has access to the `catalog`, `context`, `pipelines` and `session` variables for a Kedro project. ## A custom Kedro kernel @@ -32,16 +30,16 @@ Navigate to the project directory and issue the following command in the termina kedro jupyter notebook ``` -Your browser window will open, and you can then create a new Notebook using the dropdown and selecting the `Kedro ()` kernel. +Your browser window will open, and you can then create a new Jupyter Notebook using the dropdown and selecting the `Kedro ()` kernel. -![Create a new Notebook with Kedro (iris) kernel](../meta/images/jupyter_new_notebook.png) +![Create a new Jupyter Notebook with Kedro (iris) kernel](../meta/images/jupyter_new_notebook.png) We recommend that you store your Notebooks in the `notebooks` folder of your Kedro project. We will now give some examples of how to work with the Kedro variables. To explore the full range of attributes and methods available, you might like to consult the relevant [API documentation](/kedro) or use the [Python `dir` function](https://docs.python.org/3/library/functions.html#dir) (e.g. `dir(catalog)`). ``` {note} -If the Kedro variables are not available within your Notebook, you could have a malformed configuration file or missing dependencies. The full error message is shown on the terminal used to launch `kedro jupyter notebook`. +If the Kedro variables are not available within your Jupyter Notebook, you could have a malformed configuration file or missing dependencies. The full error message is shown on the terminal used to launch `kedro jupyter notebook`. ``` ### `catalog` @@ -178,7 +176,7 @@ You can also specify the following optional arguments for `session.run`: ## `%reload_kedro` line magic -You can use `%reload_kedro` [line magic](https://ipython.readthedocs.io/en/stable/interactive/magics.html) within your Notebook to reload the Kedro variables (for example, if you need to update `catalog` following changes to your Data Catalog). +You can use `%reload_kedro` [line magic](https://ipython.readthedocs.io/en/stable/interactive/magics.html) within your Jupyter Notebook to reload the Kedro variables (for example, if you need to update `catalog` following changes to your Data Catalog). You don't need to restart the kernel to reload the Kedro IPython extension and refresh the `catalog`, `context`, `pipelines` and `session` variables. diff --git a/docs/source/resources/index.md b/docs/source/resources/index.md new file mode 100644 index 0000000000..72493f112e --- /dev/null +++ b/docs/source/resources/index.md @@ -0,0 +1,9 @@ +# Resources + +```{toctree} +:maxdepth: 1 + +../faq/faq +glossary + +``` diff --git a/docs/source/tutorial/package_a_project.md b/docs/source/tutorial/package_a_project.md index 15dd661bea..9b28a34566 100644 --- a/docs/source/tutorial/package_a_project.md +++ b/docs/source/tutorial/package_a_project.md @@ -154,4 +154,4 @@ There are various methods to deploy packaged pipelines via Kedro plugins: * [Kedro-Docker](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-docker) plugin for packaging and shipping Kedro projects within [Docker](https://www.docker.com/) containers. * [Kedro-Airflow](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-airflow) to convert your Kedro project into an [Airflow](https://airflow.apache.org/) project. -* The [Deployment guide](../deployment/deployment_guide) touches on other deployment targets such as AWS Batch and Prefect, and there is a [range of third-party plugins for deployment](../extend_kedro/plugins.md#community-developed-plugins). +* The [Deployment guide](../deployment/index) touches on other deployment targets such as AWS Batch and Prefect, and there is a [range of third-party plugins for deployment](../extend_kedro/plugins.md#community-developed-plugins). diff --git a/docs/source/tutorial/spaceflights_tutorial.md b/docs/source/tutorial/spaceflights_tutorial.md index dc6004f9d6..8ced829765 100644 --- a/docs/source/tutorial/spaceflights_tutorial.md +++ b/docs/source/tutorial/spaceflights_tutorial.md @@ -1,4 +1,4 @@ -# Introducing spaceflights +# Next steps: Tutorial In this tutorial, we construct nodes and pipelines for a price-prediction model to illustrate the steps of a typical Kedro workflow. @@ -11,6 +11,18 @@ The tutorial takes approximately **30 minutes** to complete. You will work in th ***Project***: *You want to construct a model that predicts the price for each trip to the Moon and the corresponding return flight.* +```{toctree} +:maxdepth: 1 + +tutorial_template +set_up_data +create_a_pipeline +add_another_pipeline +package_a_project +spaceflights_tutorial_faqs +``` + + ![](../meta/images/moon-rocket.png) Photo by Ivan Diaz on Unsplash diff --git a/docs/source/visualisation/index.md b/docs/source/visualisation/index.md new file mode 100644 index 0000000000..ec679e64e4 --- /dev/null +++ b/docs/source/visualisation/index.md @@ -0,0 +1,18 @@ +# Visualisation with Kedro-Viz + + +[Kedro-Viz](https://github.com/kedro-org/kedro-viz) is a key part of Kedro. It visualises the pipelines in a Kedro project by showing data, nodes, and the connections between them. + +The Kedro-Viz package needs to be installed separately as it is not part of the standard Kedro installation: + +```bash +pip install kedro-viz +``` + +```{toctree} +:maxdepth: 1 + +kedro-viz_visualisation +visualise_charts_with_plotly +experiment_tracking +``` diff --git a/docs/source/visualisation/kedro-viz_visualisation.md b/docs/source/visualisation/kedro-viz_visualisation.md index a264c78700..179710c7d0 100644 --- a/docs/source/visualisation/kedro-viz_visualisation.md +++ b/docs/source/visualisation/kedro-viz_visualisation.md @@ -1,6 +1,5 @@ -# Get started with Kedro-Viz +# Visualise the spaceflights project -[Kedro-Viz](https://github.com/kedro-org/kedro-viz) is a key part of Kedro. It visualises the pipelines in a Kedro project by showing data, nodes, and the connections between them. This section assumes you are familiar with the basic Kedro concepts described in the [spaceflights tutorial](../tutorial/spaceflights_tutorial.md). If you have not yet worked through the tutorial, you can still follow this example. @@ -28,14 +27,6 @@ The next step is optional, but useful to check that all is working. Run the full kedro run ``` -## Visualise the spaceflights project - -The Kedro-Viz package needs to be installed separately as it is not part of the standard Kedro installation: - -```bash -pip install kedro-viz -``` - To start Kedro-Viz, type the following into your terminal from the project directory: ```bash @@ -53,8 +44,6 @@ If a visualisation panel opens up and a pipeline is not visible, refresh the vie * use the [#questions channel](https://slack.kedro.org/) on our Slack channel to ask the community for help * search the [searchable archive of Slack discussions](https://www.linen.dev/s/kedro) -### Exit an open visualisation - 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. ## Automatic visualisation updates