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

Jump to bottom

Cleanup/kedro notebook instructions #4132

Merged
merged 5 commits into from
Aug 30, 2024
Merged

Cleanup/kedro notebook instructions #4132

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
56353e6
Update add_kedro_to_a_notebook.ipynb
ethanknights Aug 30, 2024
641302c
Update add_kedro_to_a_notebook.md
ethanknights Aug 30, 2024
fcc4566
Update README.md
ethanknights Aug 30, 2024
56a1723
Update RELEASE.md minor language
ethanknights Aug 30, 2024
4102df2
Update ignore.txt
astrojuanlu Aug 30, 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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ pip install git+https://github.com/kedro-org/kedro@main
| Data Catalog | A series of lightweight data connectors used to save and load data across many different file formats and file systems, including local and network file systems, cloud object stores, and HDFS. The Data Catalog also includes data and model versioning for file-based systems. |
| Pipeline Abstraction | Automatic resolution of dependencies between pure Python functions and data pipeline visualisation using [Kedro-Viz](https://github.com/kedro-org/kedro-viz). |
| Coding Standards | Test-driven development using [`pytest`](https://github.com/pytest-dev/pytest), produce well-documented code using [Sphinx](http://www.sphinx-doc.org/en/master/), create linted code with support for [`ruff`](https://github.com/astral-sh/ruff) and make use of the standard Python logging library. |
| Flexible Deployment | Deployment strategies that include single or distributed-machine deployment as well as additional support for deploying on Argo, Prefect, Kubeflow, AWS Batch and Databricks. |
| Flexible Deployment | Deployment strategies that include single or distributed-machine deployment as well as additional support for deploying on Argo, Prefect, Kubeflow, AWS Batch, and Databricks. |

## How do I use Kedro?

The [Kedro documentation](https://docs.kedro.org/en/stable/) first explains [how to install Kedro](https://docs.kedro.org/en/stable/get_started/install.html) and then introduces [key Kedro concepts](https://docs.kedro.org/en/stable/get_started/kedro_concepts.html).

You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience
You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience.

For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html).

Expand Down
2 changes: 2 additions & 0 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@

## Documentation changes
* Fix logo on PyPI page.
* Minor language/styling updates.

## Community contributions
* [Puneet](https://github.com/puneeter)
* [ethanknights](https://github.com/ethanknights)

Check warning on line 16 in RELEASE.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Kedro.Spellings] Did you really mean 'ethanknights'?

Raw Output:
{"message": "[Kedro.Spellings] Did you really mean 'ethanknights'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 16, "column": 4}}}, "severity": "WARNING"}

# Release 0.19.8

Expand Down
2 changes: 1 addition & 1 deletion docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"metadata": {},
"source": [
"### The notebook example\n",
"The full example code is given below. To run this, you will need"
"The full example code is given below. To run this, you will need:"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/source/notebooks_and_ipython/notebook-example/add_kedro_to_a_notebook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ _Project: You want to construct a model that predicts the price for each trip to


### The notebook example
The full example code is given below. To run this, you will need
The full example code is given below. To run this, you will need:

```python
import pandas as pd
Expand Down
Loading