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.

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

Add an example of catalog.list(<regex>) and replace io to catalog in docs #3924

Merged
merged 8 commits into from
Jun 12, 2024

Conversation

noklam
Copy link
Contributor

@noklam noklam commented Jun 4, 2024

Description

It appears that catalog.list(<regex>)" is not really known by our users. I search our docs and there is no mention of it. The first step is to add an example here, then we can further improve the searching feature if we decide to move forward.

I also rename all io to catalog since it really just mean catalog and there is no point to introduce an abstract terminology IMO.

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam changed the title Noklam/fix kedro io mention Add an example of catalog.list(<regex>) and replace io to catalog in docs Jun 4, 2024
Copy link
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

Thanks @noklam ⭐ 😄

docs/source/notebooks_and_ipython/kedro_and_notebooks.md Outdated Show resolved Hide resolved
@noklam noklam requested a review from astrojuanlu June 4, 2024 15:44
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

🚀

@noklam noklam enabled auto-merge (squash) June 5, 2024 08:32
@noklam noklam requested review from AhdraMeraliQB and ElenaKhaustova and removed request for yetudada and ElenaKhaustova June 5, 2024 08:32
When you run the cell:

```ipython
['example_iris_data']

Choose a reason for hiding this comment

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

Shouldn't it output these names as well params:example_test_data_ratio, params:example_num_train_iter, params:example_learning_rate?

Screenshot 2024-06-05 at 11 23 32

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks! I should really run it in a project but it's not possible to run pandas-iris anymore. I just go on and update the docs with spaceflights instead.

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam marked this pull request as draft June 7, 2024 00:51
auto-merge was automatically disabled June 7, 2024 00:51

Pull request was converted to draft

@noklam noklam marked this pull request as ready for review June 10, 2024 08:28
@merelcht merelcht removed the request for review from AhdraMeraliQB June 10, 2024 11:16
@merelcht merelcht removed the request for review from elena-khaustova-qb June 10, 2024 11:16
@noklam
Copy link
Contributor Author

noklam commented Jun 12, 2024

hm, actually I notice Elena you have two accounts here? Which one is the correct one @elena-khaustova-qb or @ElenaKhaustova

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam noklam enabled auto-merge (squash) June 12, 2024 14:52
@noklam noklam merged commit 3c46b41 into main Jun 12, 2024
10 checks passed
@noklam noklam deleted the noklam/fix-kedro-io-mention branch June 12, 2024 14:59
bpmeek pushed a commit to bpmeek/kedro that referenced this pull request Jun 20, 2024
…g` in docs (kedro-org#3924)

* replace io with catalog

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* add usage of catalog.list()

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* fix typo

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update docs

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update the qtconsole mention

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* broken link

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: bpmeek <bpmeek.developer@gmail.com>
bpmeek pushed a commit to bpmeek/kedro that referenced this pull request Jun 20, 2024
…g` in docs (kedro-org#3924)

* replace io with catalog

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* add usage of catalog.list()

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* fix typo

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update docs

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* update the qtconsole mention

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

* broken link

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: bpmeek <bpmeek.developer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants