[GitHub] [tvm] guberti commented on issue #10706: [Docs] Add Google Colab support to tutorials

[GitBox <gi...@apache.org>]

guberti commented on issue #10706:
URL: https://github.com/apache/tvm/issues/10706#issuecomment-1098414046

   Over the last two weeks, I've spent some cycles trying to understand how this would work. On the surface, it is simple enough - just add a link to the TVM site repo. For example, clicking on this URL will open the `micro_tflite` tutorial in Colab, which can be done without modifying the code at all:
   
   https://colab.research.google.com/github/apache/tvm-site/blob/asf-site/docs/_downloads/5b279d8a8718816263fa65b0eef1a5c0/micro_tflite.ipynb
   
   However, if you try messing around with that `.ipynb` notebook, you will find it does not work. This is for two reasons - (a), the Bash blocks (which install dependencies) are not runnable, and (b) code often needs slight tweaks to run as a Python notebook. These issues are not unique to Google Colab at all - very few of the `.ipynb` files you can download from the documentation website actually work.
   
   At some point, we ought to have a discussion about whether `sphinx-gallery` is the right tool for our documentation, as it is not all that mature a project. However, that's a separate issue, so I did some work and made two pull requests to `sphinx-gallery` to fix the two issues mentioned above:
   - https://github.com/sphinx-gallery/sphinx-gallery/pull/940
   - https://github.com/sphinx-gallery/sphinx-gallery/pull/941
   
   Once these pull requests get merged, then if we choose to update our sphinx-gallery version, we will be able to generate `.ipynb` files that actually work as intended. This will also allow us to have a "open in Google Colab" button. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tvm.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org