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

📚 Add datamodule jupyter notebooks. #357

Merged
merged 25 commits into from
Jun 17, 2022

Conversation

samet-akcay
Copy link
Contributor

@samet-akcay samet-akcay commented Jun 9, 2022

Description

  • This PR adds datamodule jupyter notebooks to explain the functionality of the benchmark and custom folder datamodules. These notebook will later be used to create the documentation via nbsphinx extension.

Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • My code follows the pre-commit style and check guidelines of this project.
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes

@samet-akcay samet-akcay requested review from djdameln and ashwinvaidya17 and removed request for djdameln June 9, 2022 14:24
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

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

Thanks! I have a few comments

notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
@innat
Copy link
Contributor

innat commented Jun 12, 2022

@samet-akcay @ashwinvaidya17
To accelerate the notebook review process, I think you guys can use ReviewNB. The .ipynb file is too complicated and hard to review. But the recommended tools make it easy and intuitive.

@ashwinvaidya17
Copy link
Collaborator

@samet-akcay @ashwinvaidya17 To accelerate the notebook review process, I think you guys can use ReviewNB. The .ipynb file is too complicated and hard to review. But the recommended tools make it easy and intuitive.

Thanks! That's a great tip.

@samet-akcay samet-akcay added the Documentation Improvements or additions to documentation label Jun 13, 2022
notebooks/001-getting-started/001-getting-started.ipynb Outdated Show resolved Hide resolved
notebooks/001-getting-started/001-getting-started.ipynb Outdated Show resolved Hide resolved
notebooks/001-getting-started/001-getting-started.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-btech.ipynb Outdated Show resolved Hide resolved
notebooks/002-datamodules/002-folder.ipynb Outdated Show resolved Hide resolved
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@samet-akcay samet-akcay marked this pull request as ready for review June 14, 2022 16:49
@samet-akcay samet-akcay enabled auto-merge (squash) June 17, 2022 06:37
@samet-akcay samet-akcay dismissed ashwinvaidya17’s stale review June 17, 2022 06:38

This has been addressed

@samet-akcay samet-akcay merged commit ff1c506 into development Jun 17, 2022
@samet-akcay samet-akcay deleted the nb/sa/add-dataset-module-notebook branch June 17, 2022 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants