-
Notifications
You must be signed in to change notification settings - Fork 30
File like tutorial #638
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
File like tutorial #638
Conversation
examples/file_like.py
Outdated
# `Filesystem interfaces for Python <https://filesystem-spec.readthedocs.io/en/latest/?badge=latest>`_. | ||
# Note that using these capabilities from the fsspec` library also requires the | ||
# `aiohttp <https://docs.aiohttp.org/en/stable/>`_ module. You can install both with | ||
# ``pip install fsspec aiohttp``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@NicolasHug, the code snippet for pip install
renders kinda ugly. Rather than being one block of inline code, it renders each word separately. Do you know a better way to do it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately no, this is a pytorch-sphinx-theme issue, and it has been a problem for years :(
pytorch/pytorch_sphinx_theme#107
I hope it'll be fixed in the new theme (not sure what the status of that is).
To avoid the uglyness, maybe we can just write "pip install ..."
in quotes, without using double backticks. Or use single backticks so it renders in italics.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Unfortunate. I'll play around with it a little.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fantastic, thank you!
The example takes a bit of time to build (~3 minutes), so it does increase the duration of our docs job. I suspect it means that the doc build job now becomes our longest CI job (as it also relies on the CUDA build, which is slow).
But that's an OK price to pay for now IMHO. If it becomes too slow, we can explore reducing average_over
, or avoid benchmarking the download_before_decode()
function which is the obvious offender.
Time spent is a good point. Let me reduce |
Tutorial for streaming data through a file-like object.