Skip to content

Separate pip command syntax for notebook and CLI tabs in Quickstart#46243

Merged
stevhliu merged 5 commits into
huggingface:mainfrom
pvelayudhan:patch-1
May 29, 2026
Merged

Separate pip command syntax for notebook and CLI tabs in Quickstart#46243
stevhliu merged 5 commits into
huggingface:mainfrom
pvelayudhan:patch-1

Conversation

@pvelayudhan
Copy link
Copy Markdown
Contributor

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 install commands in the CLI tab and the !pip install commands in the notebook tab.

  • I confirm that this is not a pure code agent PR.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

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

…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.
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@pvelayudhan
Copy link
Copy Markdown
Contributor Author

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!

@stevhliu
Copy link
Copy Markdown
Member

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 # remove ! if installing from the CLI to the code snippet below for installing the libraries

@pvelayudhan
Copy link
Copy Markdown
Contributor Author

That makes sense to me, thank you for your response!

I have added in the second comment to cover both pip lines.

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! 🤗

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

@stevhliu stevhliu added this pull request to the merge queue May 29, 2026
Merged via the queue into huggingface:main with commit bb0ee88 May 29, 2026
17 checks passed
kashif pushed a commit to kashif/transformers that referenced this pull request Jun 1, 2026
…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)
@pvelayudhan pvelayudhan deleted the patch-1 branch June 3, 2026 15:51
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

Successfully merging this pull request may close these issues.

3 participants