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

Tutorials: add Open in Studio badge #2146

Merged
merged 7 commits into from
Jul 22, 2024
Merged

Conversation

adamjstewart
Copy link
Collaborator

Adds a new button to our tutorials to open them in the new Lightning Studio platform.

Based on https://lightning.ai/badge.

Still need to test, but I think this code organization is more clear in my mind.

@adamjstewart adamjstewart added this to the 0.5.3 milestone Jul 1, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 1, 2024
@adamjstewart
Copy link
Collaborator Author

I tested this and confirmed that:

  1. The Google Colab badge still works
  2. The new Lightning Studio badge works
  3. All current tutorials work in Lightning Studio

I think this is finally ready for review.

@adamjstewart adamjstewart marked this pull request as ready for review July 18, 2024 17:01
@adamjstewart
Copy link
Collaborator Author

One open question is which badge to put first, Colab or Studio. Some pros of each, based on my limited experience:

Colab

  • Simpler interface (fewer controls)
  • More popular
  • More likely to already have a Google account
  • Faster to attach compute and start running
  • Greater stability (fewer bugs)
  • Developed by Google (less likely to be abandoned in a year)

Studio

  • More powerful (more controls)
  • More reproducible (entire environment is saved)
  • Clearer usage limits for free and paid plans
  • Can clone an entire repo and run multiple tutorials consecutively without reinstalling pip dependencies
  • Choose between VS Code or Jupyter interface
  • Builtin terminal
  • Develop in Studio and immediately push to git
  • Developed by the same people who make lightning and torchmetrics, more PyTorch focused
  • Not developed by Google (more likely to get support)

Overall, Colab is more beginner friendly, but Studio is clearly superior in every way for those with even a bit of experience. After only using it for 5 min, I already know I'll never use Colab again.

I'm curious what experiences others have had and which button they think should be listed first. Since TorchGeo and Lightning are both PyTorch-focused products, I'm leaning towards Lightning, but I'm also biased. Please only comment if you've used both Colab and Studio (sign up for a free account now and give it a try!).

@calebrob6
Copy link
Member

Waiting on verification for my lightning account to test, but if it works for you then I'm good with it!

@nilsleh
Copy link
Collaborator

nilsleh commented Jul 19, 2024

Opening the notebooks in lightning-studio also worked for me.

@calebrob6 calebrob6 merged commit 87f866d into microsoft:main Jul 22, 2024
20 checks passed
@adamjstewart adamjstewart deleted the docs/studio branch July 23, 2024 05:43
@adamjstewart adamjstewart modified the milestones: 0.5.3, 0.6.0 Aug 6, 2024
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.

3 participants