Separate pip command syntax for notebook and CLI tabs in Quickstart#46243
Conversation
…I-style (pip) tabs of quicktour.md quicktour.md contains separate tabs for setting-up transformers in notebook and CLI environments, but presents notebook-style package installation (exclamation in pip install command) regardless of which tab is selected. This commit keeps the `pip install` commands in the CLI tab and the `!pip install` commands in the notebook tab.
stevhliu
left a comment
There was a problem hiding this comment.
i think we can have an even simpler fix without duplicating content. keep everything as-is after the <hfoption> block and add a comment to the code snippets like:
# remove ! if installing from the CLI
I added this in, however after looking at it I get a feeling that it clashes with the existence of the notebook/CLI tab functionality. I know it appears redundant in the .md source, but I am wondering if you would reconsider keeping the original approach based on how the rendered version appears. If you still prefer just a comment on the pip line, that's fine with me! |
|
i think they're two separate things here, the notebook/CLI tab offer different ways of logging in which is distinct from how to install PyTorch so i'd still prefer keeping it as a comment :) we should also add the comment |
|
That makes sense to me, thank you for your response! I have added in the second comment to cover both pip lines. |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
…uggingface#46243) * Separate package installation syntax for notebook-style (!pip) and CLI-style (pip) tabs of quicktour.md quicktour.md contains separate tabs for setting-up transformers in notebook and CLI environments, but presents notebook-style package installation (exclamation in pip install command) regardless of which tab is selected. This commit keeps the `pip install` commands in the CLI tab and the `!pip install` commands in the notebook tab. * Add comment to remove ! from quicktour.md CLI instructions of using pip * Add comment to remove ! from quicktour.md CLI instructions of using pip (2)
What does this PR do?
quicktour.md contains separate tabs for setting-up transformers in notebook and CLI environments, but presents notebook-style package installation (!pip install) regardless of which tab is selected. This commit updates quicktour.md to keep the
pip installcommands in the CLI tab and the!pip installcommands in the notebook tab.Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.
@stevhliu