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 tutorials to documentation #93

Merged
merged 10 commits into from
Aug 25, 2021
Merged

Add tutorials to documentation #93

merged 10 commits into from
Aug 25, 2021

Conversation

adamjstewart
Copy link
Collaborator

@adamjstewart adamjstewart commented Aug 19, 2021

This PR adds a first set of tutorials for using torchgeo. Progress so far:

  • Use nbsphinx to render notebooks in documentation
  • Consolidate existing notebooks to succinct, useful tutorials
  • Split unit and integration tests
  • Use nbmake to test notebooks and make sure they stay up-to-date

An example screenshot (still need to figure out how to fix the badge width):

tutorial

Closes #38

@adamjstewart adamjstewart added the documentation Improvements or additions to documentation label Aug 19, 2021
@adamjstewart adamjstewart mentioned this pull request Aug 19, 2021
29 tasks
@adamjstewart adamjstewart marked this pull request as ready for review August 25, 2021 01:17
@calebrob6
Copy link
Member

The Collab badge issue is caused by this piece of CSS in the theme:

article.pytorch-article img {
    width: 100%;
}

It isn't clear to me how to configure any of this though.

" sampler = RandomGeoSampler(naip.index, size=1000, length=888)\n",
" dataloader = DataLoader(dataset, batch_size=12, sampler=sampler)\n",
" duration, count = time_epoch(dataloader)\n",
" print(duration, count)"
Copy link
Member

Choose a reason for hiding this comment

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

Would be helpful to the user to print what these numbers are

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll do that in a follow-up PR. These tutorials are still pretty rudimentary.

@adamjstewart adamjstewart merged commit e72292e into main Aug 25, 2021
@adamjstewart adamjstewart deleted the docs/tutorials branch August 25, 2021 16:19
@adamjstewart
Copy link
Collaborator Author

Opened an issue for badge width: pytorch/pytorch_sphinx_theme#140

@adamjstewart adamjstewart added this to the 0.1.0 milestone Nov 20, 2021
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.

Jupyter Notebook tutorials
2 participants