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

[docs] General doc fixes #28087

Merged
merged 4 commits into from
Dec 18, 2023
Merged

[docs] General doc fixes #28087

merged 4 commits into from
Dec 18, 2023

Conversation

stevhliu
Copy link
Member

Cleans up a few things:

  • Fused AWQ benchmark table broken because there wasn't a blankline between the title and table
  • tidies up the new sections added in the GPU inference doc
  • removes the NerPipeline from internal discussion here (basically it's identical to the TokenClassification pipeline and it may cause confusion)
  • removes perf_train_tpu.md because it is empty and doesn't add any value to the docs

@stevhliu
Copy link
Member Author

Hi @amyeroberts! The CI error is:

Exception: The following objects are in the public init so should be documented:
 - NerPipeline

Would this be fixed by removing NerPipeline from the following?

@amyeroberts
Copy link
Collaborator

@stevhliu Yes, however this would stop NerPipeline being importable from the top level of transformers, which would be a breaking change.

Instead, we can make an exception for it in the doc checks by adding it to DEPRECATED_OBJECTS (which it effectively is if TokenClassificationPipeline supercedes it)

@HuggingFaceDocBuilderDev

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.

Copy link
Collaborator

@amyeroberts amyeroberts left a comment

Choose a reason for hiding this comment

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

Thanks for tidying all of this up!

@stevhliu stevhliu merged commit a52e180 into huggingface:main Dec 18, 2023
8 checks passed
@stevhliu stevhliu deleted the doc-fixes branch December 18, 2023 18:44
amyeroberts added a commit to amyeroberts/transformers that referenced this pull request Dec 19, 2023
staghado pushed a commit to staghado/transformers that referenced this pull request Jan 15, 2024
* doc fix friday

* deprecated objects

* update not_doctested

* update toctree
staghado pushed a commit to staghado/transformers that referenced this pull request Jan 15, 2024
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