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

[BE] - Deprecate colab #1742

Merged
merged 2 commits into from
Jan 9, 2024
Merged

[BE] - Deprecate colab #1742

merged 2 commits into from
Jan 9, 2024

Conversation

aclegg3
Copy link
Contributor

@aclegg3 aclegg3 commented Jan 9, 2024

Motivation and Context

Colab is a shifting foundtation for hosting tutorials. Back-end changes require updates to installers and scripts resulting in tutorial downtime and extra developer bandwidth load. Instead, we opt to deprecate Colab support and convert existing tutorials to locally-executable Jupyter notebooks.

examples/tutorials/colabs/ directory renamed to examples/tutorials/notebooks/

NOTE: partner habitat-sim PR: facebookresearch/habitat-sim#2298

How Has This Been Tested

Locally ran the Jupyter notebooks

Types of changes

  • [Docs change] Addition or changes to the documentation

Checklist

  • My code follows the code style of this project.
  • I have updated the documentation if required.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes if required.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jan 9, 2024
Copy link
Contributor

@jimmytyyang jimmytyyang left a comment

Choose a reason for hiding this comment

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

Thanks Alex!

One quick question: are those jupyter notebook runnable?


HTML(
'<iframe src="https://drive.google.com/file/d/1ltrse38i8pnJPGAXlThylcdy8PMjUMKh/preview" width="640" height="480" allow="autoplay"></iframe>'
# NOTE: this file is unreachable
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi Alex, thank you for this PR!

Do we want to remove this given that we cannot reach this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ASzot I think you set this up originally. Is this file somewhere? Is it important?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll merge the current changes and we can remove or re-link the video later.

@aclegg3 aclegg3 requested a review from ASzot January 9, 2024 16:35
@aclegg3
Copy link
Contributor Author

aclegg3 commented Jan 9, 2024

One quick question: are those jupyter notebook runnable?

Yes, I have been running them locally to test the changes. I didn't write the tutorials, so there may be some content decay, but the cells all run and produce output with no show-stopping runtime errors.

Copy link
Contributor

@jturner65 jturner65 left a comment

Choose a reason for hiding this comment

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

LGTM

@aclegg3 aclegg3 merged commit 29e3651 into main Jan 9, 2024
4 checks passed
@aclegg3 aclegg3 deleted the deprecate-colab branch January 9, 2024 17:00
jimmytyyang pushed a commit that referenced this pull request Jan 14, 2024
* rename 'colabs/' to 'notebooks/' and refactor links

* refactor colabs to running Jupyter notebooks
dannymcy pushed a commit to dannymcy/habitat-lab that referenced this pull request Jul 8, 2024
* rename 'colabs/' to 'notebooks/' and refactor links

* refactor colabs to running Jupyter notebooks
HHYHRHY pushed a commit to SgtVincent/habitat-lab that referenced this pull request Aug 31, 2024
* rename 'colabs/' to 'notebooks/' and refactor links

* refactor colabs to running Jupyter notebooks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants