bundle_class.rst 1.69 KB
Newer Older
1
2
3
4
5
6
7
..
  autogenerated from source/_templates/autosummary/bundle_class.rst

{{ name | underline }}

.. autoclass:: {{ fullname }}()

mayp777's avatar
UPDATE  
mayp777 committed
8
9
10
11
12
{%- set support_classes = [] %}
{%- if name in ["RNNTBundle.FeatureExtractor", "RNNTBundle.TokenProcessor", "Wav2Vec2FABundle.Tokenizer"] %}
  {%- set methods = ["__call__"] %}
{%- elif name == "Wav2Vec2FABundle.Aligner" %}
  {%- set attributes = [] %}
13
14
15
16
17
18
19
  {%- set methods = ["__call__"] %}
{%- elif name == "Tacotron2TTSBundle.TextProcessor" %}
  {%- set attributes = ["tokens"] %}
  {%- set methods = ["__call__"] %}
{%- elif name == "Tacotron2TTSBundle.Vocoder" %}
  {%- set attributes=["sample_rate"] %}
  {%- set methods = ["__call__"] %}
mayp777's avatar
UPDATE  
mayp777 committed
20
21
22
23
24
25
{%- elif name == "VGGishBundle.VGGish" %}
  {%- set attributes = [] %}
  {%- set methods = ["forward"] %}
{%- elif name == "VGGishBundle.VGGishInputProcessor" %}
  {%- set attributes = [] %}
  {%- set methods = ["__call__"] %}
26
27
{% endif %}

mayp777's avatar
UPDATE  
mayp777 committed
28
29
30
31
32
33
34
{%- if attributes %}

Properties
----------

{%- endif %}

35
36
37
{%- for item in attributes %}
{%- if not item.startswith('_') %}

mayp777's avatar
UPDATE  
mayp777 committed
38
{{ item | underline("~") }}
39
40
41
42
43
44
45
46

.. container:: py attribute

   .. autoproperty:: {{[fullname, item] | join('.')}}

{%- endif %}
{%- endfor %}

mayp777's avatar
UPDATE  
mayp777 committed
47
48
49
50
51
52
{%- if methods %}

Methods
-------

{%- endif %}
53
54
55
56

{%- for item in methods %}
{%- if item != "__init__" %}

mayp777's avatar
UPDATE  
mayp777 committed
57
{{item | underline("~") }}
58
59
60
61
62
63
64

.. container:: py attribute

   .. automethod:: {{[fullname, item] | join('.')}}

{%- endif %}
{%- endfor %}
mayp777's avatar
UPDATE  
mayp777 committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

{%- if support_classes %}

Support Structures
------------------

{%- endif %}

{%- for item in support_classes %}

{% set components = item.split('.') %}

{{ components[-1] | underline("~") }}

.. container:: py attribute

   .. autoclass:: {{[fullname, item] | join('.')}}
      :members:


{%- endfor %}