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

WIP (no active development) - New talktorial: Chemical space #57

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

schallerdavid
Copy link
Collaborator

@schallerdavid schallerdavid commented Nov 9, 2020

This PR holds a possible addition to TeachOpenCADD talktorials and contains examples for PCA, t-SNE, UMAP and TMAP. It's not finished at all.

TODO

Details

  • Talktorial ID: NA
  • Title: Visualization of Chemical Space
  • Original authors: David Schaller
  • Reviewer(s): NA
  • Date of review: NA

Content review

  • Potential labels or categories (e.g. machine learning, small molecules, online APIs): machine learning, small molecules
  • One line summary: Visualize chemical space of small molecules with different methods.
  • The table of contents reflects the talktorial story-line; order of #, ##, ### headers is correct
  • URLs are linked with meaningful words, instead of pasting the URL directly or linking words like here.
  • I have spell-checked the notebook
  • Images have enough resolution to be rendered with quality, without being too heavy.
  • All figures have a description
  • Markdown cell content is still in-line with code cell output (whenever results are discussed)
  • I have checked that cell outputs are not incredibly long (this applies also to DataFrames)
  • Formatting looks correctly on the Sphinx render (bold, italics, figure placing)

Code review

  • Time it took to execute (approx.):
  • Variable and function names follow snake case rules (e.g. a_variable_name vs aVariableName)
  • Spacing follows PEP8 (run Black on the code cells if needed)
  • Code line are under 99 characters each (run black -l 99)
  • Comments are useful and well placed
  • There are no unpythonic idioms like for i in range(len(list)) (see slides)
  • All 3rd party dependencies are listed at the top of the notebook
  • I have marked all code cell with output referenced in markdown cells with the label # TODO: CI
  • I have identified potential candidates for a code refactor / useful functions
  • All import ... lines are at the top (practice part) cell, ordered by standard library / 3rd party packages / our own (teachopencadd.*)
  • I have update the relative paths to absolute paths.
  • List here unfamiliar libraries you find in the imports and their intended use:

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@schallerdavid schallerdavid changed the base branch from master to packaging November 9, 2020 12:57
Base automatically changed from packaging to master November 23, 2020 10:42
@dominiquesydow dominiquesydow added the new talktorial New talktorial label Sep 8, 2021
@dominiquesydow dominiquesydow changed the title chemical space talktorial Chemical space talktorial Sep 14, 2021
@dominiquesydow dominiquesydow changed the title Chemical space talktorial New talktorial: Chemical space Sep 23, 2021
@AndreaVolkamer AndreaVolkamer changed the title New talktorial: Chemical space WIP (no active development) - New talktorial: Chemical space Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new talktorial New talktorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants