Skip to content

Commit 1330d9c

Browse files
committed
Adding more docs and references
1 parent 28ce749 commit 1330d9c

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed

docs/source/models.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,7 @@ pre-trained weights:
459459
.. toctree::
460460
:maxdepth: 1
461461

462+
models/video_mvitv2
462463
models/video_resnet
463464

464465
|

docs/source/models/video_mvitv2.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Video ResNet
2+
============
3+
4+
.. currentmodule:: torchvision.models.video
5+
6+
The MViTv2 model is based on the
7+
`MViTv2: Improved Multiscale Vision Transformers for Classification and Detection
8+
<https://arxiv.org/abs/2112.01526>`__ and `Multiscale Vision Transformers
9+
<https://arxiv.org/abs/2104.11227>`__ papers.
10+
11+
12+
Model builders
13+
--------------
14+
15+
The following model builders can be used to instantiate a MViTV2 model, with or
16+
without pre-trained weights. All the model builders internally rely on the
17+
``torchvision.models.video.MViTV2`` base class. Please refer to the `source
18+
code
19+
<https://github.com/pytorch/vision/blob/main/torchvision/models/video/mvitv2.py>`_ for
20+
more details about this class.
21+
22+
.. autosummary::
23+
:toctree: generated/
24+
:template: function.rst
25+
26+
mvitv2_t
27+
mvitv2_s
28+
mvitv2_b

torchvision/models/video/mvitv2.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,8 @@ def mvitv2_t(*, weights: Optional[MViTV2_T_Weights] = None, progress: bool = Tru
468468
"""
469469
Constructs a tiny MViTv2 architecture from
470470
`MViTv2: Improved Multiscale Vision Transformers for Classification and Detection
471-
<https://arxiv.org/abs/2112.01526>`__.
471+
<https://arxiv.org/abs/2112.01526>`__ and `Multiscale Vision Transformers
472+
<https://arxiv.org/abs/2104.11227>`__.
472473
473474
Args:
474475
weights (:class:`~torchvision.models.video.MViTV2_T_Weights`, optional): The
@@ -503,9 +504,10 @@ def mvitv2_t(*, weights: Optional[MViTV2_T_Weights] = None, progress: bool = Tru
503504

504505
def mvitv2_s(*, weights: Optional[MViTV2_S_Weights] = None, progress: bool = True, **kwargs: Any) -> MViTv2:
505506
"""
506-
Constructs a tiny MViTv2 architecture from
507+
Constructs a small MViTv2 architecture from
507508
`MViTv2: Improved Multiscale Vision Transformers for Classification and Detection
508-
<https://arxiv.org/abs/2112.01526>`__.
509+
<https://arxiv.org/abs/2112.01526>`__ and `Multiscale Vision Transformers
510+
<https://arxiv.org/abs/2104.11227>`__.
509511
510512
Args:
511513
weights (:class:`~torchvision.models.video.MViTV2_S_Weights`, optional): The
@@ -540,9 +542,10 @@ def mvitv2_s(*, weights: Optional[MViTV2_S_Weights] = None, progress: bool = Tru
540542

541543
def mvitv2_b(*, weights: Optional[MViTV2_B_Weights] = None, progress: bool = True, **kwargs: Any) -> MViTv2:
542544
"""
543-
Constructs a tiny MViTv2 architecture from
545+
Constructs a base MViTv2 architecture from
544546
`MViTv2: Improved Multiscale Vision Transformers for Classification and Detection
545-
<https://arxiv.org/abs/2112.01526>`__.
547+
<https://arxiv.org/abs/2112.01526>`__ and `Multiscale Vision Transformers
548+
<https://arxiv.org/abs/2104.11227>`__.
546549
547550
Args:
548551
weights (:class:`~torchvision.models.video.MViTV2_B_Weights`, optional): The

0 commit comments

Comments
 (0)