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

Jupyter Notebooks for Documentation #211

Open
ParagEkbote opened this issue Jan 15, 2025 · 4 comments
Open

Jupyter Notebooks for Documentation #211

ParagEkbote opened this issue Jan 15, 2025 · 4 comments

Comments

@ParagEkbote
Copy link

The documentation does not yet contain notebooks for the various tutorials and guides available. I have previously contributed to the diffusers library by adding the notebooks to huggingface/notebook repo and linking them with the relevant documentation pages. Could you please let me know from which pages to begin from and the level of technical details to be added?

Reference:

huggingface/diffusers#9905

huggingface/diffusers#10032

huggingface/notebooks#535

cc: @aymeric-roucher

@ParagEkbote ParagEkbote changed the title Jupyter Notebooks for documentation Jupyter Notebooks for Documentation Jan 15, 2025
@aymeric-roucher
Copy link
Collaborator

Thanks a lot @ParagEkbote ! To be sure, is that the notebooks that are then shown to users when clicking the "Open in colab" button? That would be amazing to have!

@ParagEkbote
Copy link
Author

@stevhliu Do you think that I have missed anything?

Could you please let me know?

@stevhliu
Copy link
Member

@aymeric-roucher, the doc-builder stopped automatically building/updating newer notebooks (see this Slack thread) so the [[open-in-colab]] button doesn't work.

@ParagEkbote is manually converting the tutorials/guides into notebooks that can then be linked in the docs :)

@ParagEkbote
Copy link
Author

Could you please let me know what to do next for adding the notebooks?

cc: @aymeric-roucher

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants