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

Add ability to get a list of supported pipeline tasks #14732

Merged
merged 1 commit into from
Dec 13, 2021
Merged

Add ability to get a list of supported pipeline tasks #14732

merged 1 commit into from
Dec 13, 2021

Conversation

codesue
Copy link
Contributor

@codesue codesue commented Dec 12, 2021

What does this PR do?

This change adds the ability to programmatically get a list of supported pipeline tasks.

Currently, when new users want to know which tasks are supported in a pipeline, we have to reference the Pipelines documentation or parse the SUPPORTED_TASKS and TASK_ALIASES dictionaries. Being able to programmatically get a list of supported pipeline tasks would be more convenient since it requires less context switching and parsing.

Example usage:

>>> from transformers.pipelines import get_supported_tasks
>>> print(*get_supported_tasks(), sep=“\n”)
audio-classification
automatic-speech-recognition
conversational
feature-extraction
fill-mask
image-classification
image-segmentation
ner
object-detection
question-answering
sentiment-analysis
summarization
table-question-answering
text-classification
text-generation
text2text-generation
token-classification
translation
zero-shot-classification

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.

@LysandreJik @Narsil

@julien-c
Copy link
Member

Thanks for the PR!

Off-topic from the actual PR but for background information, this is where the "canonical" list of pipelines (even outside of transformers) supported by the HuggingFace hub is stored: https://github.com/huggingface/huggingface_hub/blob/main/widgets/src/lib/interfaces/Types.ts

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

Thank you for your PR, @codesue, this is useful! The failing tests are unrelated to your PR and are currently being fixed.

LGTM

Copy link
Contributor

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM

@LysandreJik LysandreJik merged commit c17e7cd into huggingface:master Dec 13, 2021
@codesue
Copy link
Contributor Author

codesue commented Dec 13, 2021

Thanks for the reviews, everyone! And, wow, that was so fast! 🤩

@codesue codesue deleted the add-ability-to-get-supported-tasks branch December 13, 2021 23:07
Albertobegue pushed a commit to Albertobegue/transformers that referenced this pull request Jan 27, 2022
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.

4 participants