Streamline debugging documentation #3608
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Co-authored-by: Jo Stichbury <[email protected]> Signed-off-by: L. R. Couto <[email protected]>
Co-authored-by: Ahdra Merali <[email protected]> Signed-off-by: L. R. Couto <[email protected]>
Signed-off-by: lrcouto <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
AhdraMeraliQB
requested review from
yetudada,
astrojuanlu and
stichbury
as code owners
Signed-off-by: Ahdra Merali <[email protected]>
AhdraMeraliQB
changed the title
Signed-off-by: Ahdra Merali <[email protected]>
AhdraMeraliQB
requested review from
noklam and
lrcouto
and removed request for
yetudada
AhdraMeraliQB
commented
Feb 9, 2024
| @@ -201,7 +201,7 @@ HOOKS = (AzureSecretsHook(),) | |||
| Note: `DefaultAzureCredential()` is Azure's recommended approach to authorise access to data in your storage accounts. For more information, consult the [documentation about how to authenticate to Azure and authorize access to blob data](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-python). | |||
| ``` | |||
|
|
|||
| ## Use a Hook to read `metadata` from `DataCatalog` | |||
| ## Use Hooks to read `metadata` from `DataCatalog` | |||
There was a problem hiding this comment.
Changed tense for consistency
AhdraMeraliQB
commented
Feb 9, 2024
| @@ -214,3 +214,77 @@ class MetadataHook: | |||
| for dataset_name, dataset in catalog.datasets.__dict__.items(): | |||
| print(f"{dataset_name} metadata: \n {str(dataset.metadata)}") | |||
| ``` | |||
|
|
|||
| ## Use Hooks to debug your pipeline | |||
There was a problem hiding this comment.
This section was ported over from debugging.md
AhdraMeraliQB
commented
Feb 9, 2024
|
|
||
| ### Debugging with %debug and %pdb | ||
| ## Debugging a Kedro project within a notebook |
There was a problem hiding this comment.
This subsection is subject to further changes in #2011
stichbury
reviewed
Feb 9, 2024
stichbury
reviewed
Feb 9, 2024
stichbury
reviewed
Feb 9, 2024
stichbury
reviewed
Feb 9, 2024
stichbury
reviewed
Feb 9, 2024
stichbury
approved these changes
Feb 9, 2024
There was a problem hiding this comment.
Few minor comments but looks fantastic, thanks @AhdraMeraliQB !
Co-authored-by: Jo Stichbury <[email protected]> Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Addresses #2672. Blocks #2011.
As discussed with Jo - this is the new proposed structure:
Tutorial and basic Kedro usage
Advanced Usage
It was flagged that the debugging page shouldn't be wholly removed, instead now it serves as a source for links on the specific debugging workflows
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-byline 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
RELEASE.mdfile