Skip to content

Conversation

@AbSsEnT
Copy link
Contributor

@AbSsEnT AbSsEnT commented Aug 21, 2023

Making comments for the dataset and model creation consistent across notebooks.

@AbSsEnT AbSsEnT added the enhancement New feature or request label Aug 21, 2023
@AbSsEnT AbSsEnT requested a review from Inokinoki August 21, 2023 15:25
@AbSsEnT AbSsEnT self-assigned this Aug 21, 2023
@linear
Copy link

linear bot commented Aug 21, 2023

GSK-1554 Make example notebooks consistent with the Wrap Dataset page

In the documentation, in the 'quickstart' example we are using 'cat_columns' during Dataset creation. However another examples are mostly using 'column_types' during Dataset creation, without any comments, which confuses the user. We need to replace 'column_types' parameter by the 'cat_columns'. (and put the comments)

This relates to the user-test with Princy: https://www.notion.so/giskard/4dbd310a5f854d608a3f54b502d1e5b8?v=68d5847ab02749e994f90a1271a6574f&p=3e445eca8e10475baa3868063ac5e4c5&pm=s

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@Inokinoki
Copy link
Member

LGTM.

Despite of the metadata in Jupyter Notebook, I think the most common changes are to add the names of function argument and the comments, according to our docs, right?

Could we add a title to conclude the changes in this PR?

@AbSsEnT AbSsEnT changed the title GSK-1554 GSK-1554: Making comments for the dataset and model creation consistent across notebooks. Aug 22, 2023
@AbSsEnT
Copy link
Contributor Author

AbSsEnT commented Aug 22, 2023

Done

@AbSsEnT AbSsEnT merged commit 4d2783b into main Aug 22, 2023
@Hartorn Hartorn deleted the GSK-1554-make-example-notebooks-consistent branch September 13, 2023 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Development

Successfully merging this pull request may close these issues.

3 participants