SUMIN/HuggingFace_transformer
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

[Doc] Fix docbuilder - make BackboneMixin and BackboneConfigMixin importable from utils. (#29002)

Browse Source 
* Trigger doc build

* Test removing references

* Importable from utils

* Trigger another run on a new commit for testing
This commit is contained in:
amyeroberts
2024-02-14 10:29:22 +00:00
committed by GitHub
parent 1ecf5f7c98
commit 7252e8d937
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/en/main_classes/backbones.md
View File

@@ -18,8 +18,8 @@ rendered properly in your Markdown viewer.
A backbone is a model used for feature extraction for higher level computer vision tasks such as object detection and image classification. Transformers provides an [`AutoBackbone`] class for initializing a Transformers backbone from pretrained model weights, and two utility classes: A backbone is a model used for feature extraction for higher level computer vision tasks such as object detection and image classification. Transformers provides an [`AutoBackbone`] class for initializing a Transformers backbone from pretrained model weights, and two utility classes:
* [`~utils.backbone_utils.BackboneMixin`] enables initializing a backbone from Transformers or [timm](https://hf.co/docs/timm/index) and includes functions for returning the output features and indices. * [`~utils.BackboneMixin`] enables initializing a backbone from Transformers or [timm](https://hf.co/docs/timm/index) and includes functions for returning the output features and indices.
* [`~utils.backbone_utils.BackboneConfigMixin`] sets the output features and indices of the backbone configuration. * [`~utils.BackboneConfigMixin`] sets the output features and indices of the backbone configuration.
[timm](https://hf.co/docs/timm/index) models are loaded with the [`TimmBackbone`] and [`TimmBackboneConfig`] classes. [timm](https://hf.co/docs/timm/index) models are loaded with the [`TimmBackbone`] and [`TimmBackboneConfig`] classes.
@@ -45,11 +45,11 @@ Backbones are supported for the following models:
## BackboneMixin ## BackboneMixin
[[autodoc]] utils.backbone_utils.BackboneMixin [[autodoc]] utils.BackboneMixin
## BackboneConfigMixin ## BackboneConfigMixin
[[autodoc]] utils.backbone_utils.BackboneConfigMixin [[autodoc]] utils.BackboneConfigMixin
## TimmBackbone ## TimmBackbone

1
src/transformers/utils/__init__.py
View File

@@ -20,6 +20,7 @@ from huggingface_hub.constants import HF_HUB_DISABLE_TELEMETRY as DISABLE_TELEME
from packaging import version from packaging import version
from .. import __version__ from .. import __version__
from .backbone_utils import BackboneConfigMixin, BackboneMixin
from .constants import IMAGENET_DEFAULT_MEAN, IMAGENET_DEFAULT_STD, IMAGENET_STANDARD_MEAN, IMAGENET_STANDARD_STD from .constants import IMAGENET_DEFAULT_MEAN, IMAGENET_DEFAULT_STD, IMAGENET_STANDARD_MEAN, IMAGENET_STANDARD_STD
from .doc import ( from .doc import (
add_code_sample_docstrings, add_code_sample_docstrings,