Skip to content

Add auto_docstring decorator to Sam3ImageProcessorFast#43267

Open
anthonyylee wants to merge 2 commits into
huggingface:mainfrom
anthonyylee:patch-1
Open

Add auto_docstring decorator to Sam3ImageProcessorFast#43267
anthonyylee wants to merge 2 commits into
huggingface:mainfrom
anthonyylee:patch-1

Conversation

@anthonyylee

Copy link
Copy Markdown
Contributor

Sam3ImageProcessorFast inherits from Sam2ImageProcessorFast, however the docstring decorator is left out and only the SAM2 decorated preprocess method is showing up in Sam3ImageProcessorFast's documentation.

What does this PR do?

Improved the SAM3 model documentation.

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.

@yonigozlan
@ronghanghu

[Sam3ImageProcessorFast](https://huggingface.co/docs/transformers/main/en/model_doc/sam3#transformers.Sam3ImageProcessorFast) inherits from [Sam2ImageProcessorFast](https://huggingface.co/docs/transformers/main/en/model_doc/sam2#transformers.Sam2ImageProcessorFast), however the docstring decorator is left out and only the SAM2 decorated `preprocess` method is showing up in Sam3ImageProcessorFast's documentation.
@github-actions

Copy link
Copy Markdown
Contributor

[For maintainers] Suggested jobs to run (before merge)

run-slow: sam3

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.

1 participant