Skip to content

fix: add notebook environment self-check and actionable setup guidance#31

Open
khanfs wants to merge 3 commits intofacebookresearch:mainfrom
khanfs:fix/notebook-env-checks
Open

fix: add notebook environment self-check and actionable setup guidance#31
khanfs wants to merge 3 commits intofacebookresearch:mainfrom
khanfs:fix/notebook-env-checks

Conversation

@khanfs
Copy link
Copy Markdown

@khanfs khanfs commented Apr 7, 2026

Summary

This PR improves the notebook onboarding path by adding an environment self-check and clearer setup guidance for notebook / Colab users.

Changes

  • add an environment check cell to tribe_demo.ipynb
  • add a lightweight import smoke-test cell before model loading
  • add a short README note for notebook users about restarting the runtime and checking optional dependencies

Why

The README points users to the Colab demo notebook for a full walkthrough. This PR makes that path easier to diagnose when users hit missing dependencies, missing ffmpeg, or notebook import issues, while keeping the scope narrow.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 7, 2026
@khanfs khanfs force-pushed the fix/notebook-env-checks branch from 3730f91 to ca49a7c Compare April 7, 2026 14:37
@khanfs
Copy link
Copy Markdown
Author

khanfs commented Apr 7, 2026

I hit a few local environment issues while testing the notebook path, so this PR adds a lightweight environment check to make first-time setup failures easier to diagnose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant