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.

Sign up for GitHub

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

Jump to bottom

[TODO]: Add example notebooks to the docs #556

Open
davidegraff opened this issue Dec 18, 2023 · 4 comments · Fixed by #467 · May be fixed by #904, #772 or #910
Open

[TODO]: Add example notebooks to the docs #556

davidegraff opened this issue Dec 18, 2023 · 4 comments · Fixed by #467 · May be fixed by #904, #772 or #910
Assignees
@kevingreenman @hwpang @donerancl @joelnkn
Labels
enhancement a new feature request mlpds Issue/PR by MLPDS member (priority) todo add an item to the to-do list
Milestone
v2.1.0

Comments

@davidegraff
Copy link
Contributor

Sphinx supports embedding jupyter notebooks into docs. We should add the notebooks we've written here instead of manually writing out additional python examples in ReST.

Note: we should add commentary and formatting to the notebook before adding them in so that users can follow along better
@davidegraff davidegraff added enhancement a new feature request todo add an item to the to-do list labels Dec 18, 2023
@davidegraff davidegraff added this to the v2.0.0 milestone Dec 18, 2023
@davidegraff
Copy link
Contributor Author

should be fixed by #467 or added later. Also linked to #448

@kevingreenman kevingreenman mentioned this issue Dec 20, 2023
Merged
2 tasks
@kevingreenman
Copy link
Member

also linked to #616

@kevingreenman
Copy link
Member

kevingreenman commented Jan 30, 2024 •
edited by joelnkn

Collecting a list here of notebooks we have or want to have:

  • training (single target regression)
  • training (multi-component regression)
  • training (reaction regression)
  • training (spectra regression)
  • prediction (single target regression)
  • prediction (multi-component regression)
  • converting model from v1 to v2
  • custom featurizers
  • extracting molecule fingerprints from MPNN (and maybe visualize with PCA)
  • active learning
  • attribution
  • transfer learning

@davidegraff
Copy link
Contributor Author

a suggestion: we this section in the docs should be called "cookbook"

@donerancl donerancl self-assigned this Feb 2, 2024
@joelnkn joelnkn mentioned this issue Feb 13, 2024
Open
3 tasks
@kevingreenman kevingreenman linked a pull request Feb 28, 2024 that will close this issue
v2: update docs #467
Merged
@kevingreenman kevingreenman modified the milestones: v2.0.0-rc.1, v2.0.0 Mar 2, 2024
@kevingreenman kevingreenman linked a pull request Mar 2, 2024 that will close this issue
V2: Add more example notebooks #676
Closed
@kevingreenman kevingreenman mentioned this issue Mar 2, 2024
Closed
@kevingreenman kevingreenman added the mlpds Issue/PR by MLPDS member (priority) label Mar 2, 2024
@kevingreenman kevingreenman modified the milestones: v2.0.0, v2.1.0 Apr 4, 2024
@kevingreenman kevingreenman linked a pull request Apr 11, 2024 that will close this issue
V2: Add more example notebooks #772
Draft
@kevingreenman kevingreenman linked a pull request Apr 18, 2024 that will close this issue
Draft
This was referenced Jun 5, 2024
Closed
Open
Draft
This was linked to pull requests Jun 7, 2024
Add new example notebook for active learning #910
Draft
Add new example notebook for transfer learning #904
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kevingreenman kevingreenman

@hwpang hwpang

@donerancl donerancl

@joelnkn joelnkn

Labels
enhancement a new feature request mlpds Issue/PR by MLPDS member (priority) todo add an item to the to-do list
Projects
None yet
Milestone
v2.1.0
5 participants
@kevingreenman @hwpang @donerancl @davidegraff @joelnkn