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

Define a simpler PenguinDataset in Exercise 1 notebook #73

Merged
merged 9 commits into from
Jul 9, 2024

Conversation

ma595
Copy link
Member

@ma595 ma595 commented Jul 4, 2024

This PR creates a simpler PenguinDataset within the worked-solutions/01_penguin_classification_solutions.ipynb notebook.

Within this easier PenguinDataset we:

  • Move ontents of _load_penguin_data(...) and _split_data(...) into __init__()
  • Remove lambdas and Compose object, making it easier to follow.
  • Remove docstrings (I am aware that this isn't ideal, but I think it is fine for this purpose). Any objections, please comment.

Other notebook changes include:

  • The unchanged _penguins.py has been referenced in the notebook as an example of good software practice.
  • Markdown has been modified to make the notebook easier to follow in light of the above changes.
    • Mention of why data reading code is encapsulated in a class
  • All discussion on Compose has been removed.

Before merging, the following tasks must be completed:
Propagate changes to:

  • exercise notebook
  • colab - (is NOT done automatically - This is done by rebasing or merging into the colab branch - consider doing this after merging to main.)
  • ex 2+? Consider leaving this as is.

Closes #71

@ma595
Copy link
Member Author

ma595 commented Jul 4, 2024

@jatkinson1000 would you prefer the jupyter notebook outputs to be retained?

@ma595 ma595 marked this pull request as draft July 4, 2024 16:24
@ma595 ma595 self-assigned this Jul 4, 2024
@ma595 ma595 marked this pull request as ready for review July 4, 2024 17:40
@ma595
Copy link
Member Author

ma595 commented Jul 4, 2024

Jack confirmed that we should retain the cell outputs of the solutions notebook for reference.

@ma595 ma595 changed the title Define a simpler PenguinDataset in the notebook Define a simpler PenguinDataset in Exercise 1 notebook Jul 5, 2024
Copy link
Member

@jatkinson1000 jatkinson1000 left a comment

Choose a reason for hiding this comment

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

This all looks sensible to me in theory @ma595

Caveat that I have not run the code and will leave this (and approval) to @surbhigoel77 as the co-presenter.

I agree that it would be easier to move changes to the colab branch after merging to main.

Also consider how other exercises might need adapting.

exercises/01_penguin_classification.ipynb Show resolved Hide resolved
exercises/01_penguin_classification.ipynb Show resolved Hide resolved
Copy link
Member

@surbhigoel77 surbhigoel77 left a comment

Choose a reason for hiding this comment

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

Runs fine for me,

@ma595 ma595 merged commit e7de0a7 into main Jul 9, 2024
2 checks passed
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.

Simpler PenguinDataset
3 participants