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

[Review] Machine Learning for the 20th century: Can a United Kingdom database from 1987 classify a glass cosmetics jar from the 1930s that might have belonged to Amelia Earhart? #187

Open
20 tasks
crangelsmith opened this issue Jul 6, 2022 · 5 comments
Assignees

Comments

@crangelsmith
Copy link
Collaborator

Story Review: Issue 174

Story Name: Machine Learning for the 20th century: Can a United Kingdom database from 1987 classify a glass cosmetics jar from the 1930s that might have belonged to Amelia Earhart?

Submitting Author: joecerniglia

Pull Request: #176

Reviewers: @lukehare , Eirini Zormpa and Jennifed Ding

Reviewer instructions & questions

@lukehare, Eirini Zormpa and Jennifed Ding , please carry out your review in this issue by updating the checklist below, and writing new comments in case you have any questions. Specific comments about text can be done using the ReviewNB app linked to the PR. If you cannot edit the checklist please:

Any questions, concerns or suggestions regarding the review process please let @crangelsmith, @DavidBeavan or @samvanstroud know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Review Checklist

Code of conduct

  • I confirm that I read and will adhere to the Turing Data Stories code of conduct.

General checks

  • Notebook: Is the source code for this data story available as a notebook in the linked pull request?
  • Contribution and authorship: Are the authors clearly listed? Does the author list seem appropriate and complete?
  • Scope and eligibility: Does the submission contain an original and complete analysis of open data? Is the story aligned with the Turing Data Stories vision statement?

Reproducibility

  • Does the notebook run in a local environment?
  • Does the notebook build and run in binder?
  • Are all data sources openly accessible and properly cited with a link?
  • Are the data open, and do they have an explicit licence, provenance and attribution?

Pedagogy

  • Does the story demonstrate some specific data analysis or visualisation techniques?
  • Are these techniques well motivated?
  • Are these techniques well implemented?
  • Is the notebook well documented, using both markdown cells and comments in code cells?
  • Does the notebook has a introduction section motivating the story?
  • Does the notebook has a conclusion section discussing the main insight from the stories?
  • Is the paper well written (it does not require editing for structure, language, or writing quality)?

Context

  • Does the story give an insight into some societal issue?
  • Is the context around this issue well referenced (newspaper articles, scientific papers, etc.)?

Ethical

  • Is any linkage of datasets in the story unlikely to lead to an increased risk of the personal identification of individuals?
  • Is the Story truthful and clear about any limitations of the analysis (and potential biases in data)?
  • Is the Story unlikely to lead to negative social outcomes, such as (but not limited to) increasing discrimination or injustice?

AOB

Please use the ReviewNB app to submit your reviews on the notebook, the story to be reviewed is under the name stories/2022-03-27_Glass_ML/ML_20th_Century.ipynb. Other files are complementary and do not need to be reviewed.

Agree between yourselves on how to divide the review work. For example, one could take the more technical review and others focus on the storytelling, etc.

@crangelsmith crangelsmith assigned lukehare and unassigned lukehare Jul 6, 2022
@eirini-zormpa
Copy link
Member

thank you for the explanation 😊 this link: https://github.com/alan-turing-institute/TuringDataStories/settings/access doesn't seem to work?

@crangelsmith
Copy link
Collaborator Author

thank you for the explanation 😊 this link: https://github.com/alan-turing-institute/TuringDataStories/settings/access doesn't seem to work?

Oh sorry about that! I have now added you as a collaborator to the project, so you should have access now.

@dingaaling
Copy link
Collaborator

@crangelsmith could you add me as well? link currently doesn't work for me either!

@lukehare
Copy link
Collaborator

lukehare commented Jul 20, 2022

Review Checklist

Code of conduct

  • I confirm that I read and will adhere to the Turing Data Stories code of conduct.

General checks

  • Notebook: Is the source code for this data story available as a notebook in the linked pull request?
  • Contribution and authorship: Are the authors clearly listed? Does the author list seem appropriate and complete?
  • Scope and eligibility: Does the submission contain an original and complete analysis of open data? Is the story aligned with the Turing Data Stories vision statement?

Reproducibility

  • Does the notebook run in a local environment? Outstanding question for TDS team to decide on how to handle story-specific packages (See How to handle story-specific packages #205)
  • Does the notebook build and run in binder? Binder builds, but as above, dataset is missing.
  • Are all data sources openly accessible and properly cited with a link?
  • Are the data open, and do they have an explicit licence, provenance and attribution?

Pedagogy

  • Does the story demonstrate some specific data analysis or visualisation techniques?
  • Are these techniques well motivated?
  • Are these techniques well implemented?
  • Is the notebook well documented, using both markdown cells and comments in code cells?
  • Does the notebook has a introduction section motivating the story?
  • Does the notebook has a conclusion section discussing the main insight from the stories?
  • Is the paper well written (it does not require editing for structure, language, or writing quality)?

Context

  • Does the story give an insight into some societal issue?
  • Is the context around this issue well referenced (newspaper articles, scientific papers, etc.)?

Ethical

  • Is any linkage of datasets in the story unlikely to lead to an increased risk of the personal identification of individuals?
  • Is the Story truthful and clear about any limitations of the analysis (and potential biases in data)?
  • Is the Story unlikely to lead to negative social outcomes, such as (but not limited to) increasing discrimination or injustice?

@crangelsmith
Copy link
Collaborator Author

crangelsmith commented Oct 11, 2022 via email

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

No branches or pull requests

4 participants