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

Issue 3266 #3267

Merged
merged 9 commits into from
May 30, 2024
Merged

Issue 3266 #3267

merged 9 commits into from
May 30, 2024

Conversation

charlottejmc
Copy link
Contributor

@charlottejmc charlottejmc commented May 17, 2024

I have suggested some changes to the lesson text, to reflect the fact that readers are now using the accompanying Jupyter Notebook on Google Colab rather than on Kaggle, as was originally the case.

The biggest change was the ### Kaggle section (now ### Google Colab), which I have updated to ensure the instructions are now relevant to Colab.

Closes #3266

Checklist

  • Assign yourself in the "Assignees" menu
  • Add the appropriate "Label"
  • If this PR closes an Issue, add the phrase Closes #ISSUENUMBER to your summary above
  • Ensure the status checks pass: if you have difficulty fixing build errors, please contact our Publishing Manager @anisa-hawes
  • Check the Netlify Preview: navigate to netlify/ph-preview/deploy-preview and click 'details' (at right)
  • Assign at least one individual or team to "Reviewers"
    • [ ] if the text needs to be translated, please follow the translation request guidelines, then assign the relevant language team(s) as "Reviewers" and tag both the team as well as the managing editor in your PR.

Update lesson to refer to Google Colab rather than Kaggle
Update to refer to Google Colab notebook instead of Kaggle
@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 17, 2024

Hello @hawc2,

Daniel @davanstrien has very kindly provided us with a revised version of the codebook associated with computer-vision-deep-learning-pt1 and computer-vision-deep-learning-pt2 to support us to migrate it from Kaggle to Google Colab.

We’ve now uploaded it to our organisationally hosted Colab space. @charlottejmc and I have made some additional adjustments to the codebook so that it consists of the code + essential line comments only, headings and subheadings that mirror the lesson, and does not extend or replicate the lesson’s commentary. (You’ll remember that one codebook is linked to both parts of the lesson).

We’ve also prepared a first draft of revisions to the original EN lesson which you can review in rich-diff here so that the sections and sentences that refer to the specifics of working with Kaggle are removed. We'd be grateful for your thoughts/comments/suggestions.

Thank you.
Anisa

@charlottejmc
Copy link
Contributor Author

Hi @davanstrien,

Thanks again for your patience as we make these changes.

I've tried to ensure my edits are accurate, but please do carefully review them and flag anything that doesn't seem right to you.

  • Could you please take a close look at the ## Suggested Experiments section in Part 1 (line 436 of computer-vision-deep-learning-pt1.md, as I wasn't able to determine myself whether this would still work the same on Colab.
  • Part 2 of the new Colab notebook seemed to be missing a code block (compared to the lesson text) under 'Loading Data':
from fastai.vision.all import *

I have chosen to add this in to the notebook, but please let me know if it needs to be removed.

  • I noticed there may be some discrepancies between the notebook and the lesson code. For example, in Part 2, at line 969 of computer-vision-deep-learning-pt2.md, the results show 0.6308501468079952, compared to 0.5519872296565753 in the Colab notebook. This may be totally fine. I just thought I would point it out.

@anisa-hawes anisa-hawes removed their request for review May 17, 2024 17:24
@hawc2
Copy link
Contributor

hawc2 commented May 19, 2024

Great, thanks everyone for this big improvement to the code for the lesson!

@anisa-hawes
Copy link
Contributor

Thank you for approving this, @hawc2.

I've written to Daniel to ask if he can advise on the two small queries raised above.

But if you're happy as things are, we could make those tweaks at a later date (if necessary)?

@hawc2
Copy link
Contributor

hawc2 commented May 22, 2024

oh ok @anisa-hawes yeah let's make those changes first if possible

@anisa-hawes
Copy link
Contributor

anisa-hawes commented May 24, 2024

Hello @davanstrien and @kasparvonbeelen,

As I mentioned in my email, when migrating the codebook which accompanies this lesson from Kaggle to Colab, we noted a few points of query which we'd like to ask for your advice on:

  1. In the ## Suggested Experiments section in Part 1 (lines 436-443 of the Markdown file computer-vision-deep-learning-pt1.md), you outline some options for adjusting various settings and parameters. Are these options for experimenting available in Colab as they were in Kaggle?

  2. We noticed that the line of code from fastai.vision.all import * seemed to be missing from Part 2 'Loading Data' of the revised codebook, although it appears in the corresponding section of the lesson. We've added this, but would like to confirm it with you. Is the line from fastai.vision.all import * correctly included in the revised codebook?

  3. We noted some discrepancies between the f1_score values quoted in the notebook and in the lesson. Am I correct in understanding that these precision metrics vary each time they are calculated?

You can review a full preview of the revised lesson here, and review the revised codebook as it will be here.

We're grateful for your help to resolve these queries.

Your lessons have proved popular with our community, and we're excited to have received proposals for potential translations into Spanish and French 🙂

@charlottejmc
Copy link
Contributor Author

Following @anisa-hawes' comment, I've done a bit more investigating and we both agree on my findings:

  • Q1: This section is about playing around with certain variables within fastai, which is a package that can be installed using Kaggle and Colab interchangeably. So, this will probably not need any updates.
  • Q2: We can't be exactly sure about this without the authors' direct input, but it does seem logical to repeat the same code cells/ code blocks across the markdown and the notebook
  • Q3: I've looked into the f1_score value, it's apparently normal that it would vary every time the model is run.

@charlottejmc charlottejmc merged commit 98c2b29 into gh-pages May 30, 2024
5 checks passed
@charlottejmc
Copy link
Contributor Author

Merging this PR with @hawc2's approval. @davanstrien and @kasparvonbeelen, if you find anything that still needs to be changed, please do let us know and I will reopen a branch.

@charlottejmc charlottejmc deleted the Issue-3266 branch May 30, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updating en/computer-vision-deep-learning to reflect transition from Kaggle to Google Colab
3 participants