io_class.rst 1.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
..
  autogenerated from source/_templates/autosummary/io_class.rst

{#-
    ################################################################################
    # autosummary template for torchaudio.io module
    # Since StreamReader/StreamWriter have many methods/properties,
    # we want to list them up in the table of contents.
    # The default class template does not do this, so we use custom one here.
    ################################################################################
#}

{{ name | underline }}

.. autoclass:: {{ fullname }}

{%- if attributes %}

Properties
mayp777's avatar
UPDATE  
mayp777 committed
20
----------
21
22
23
24

{%- for item in attributes %}
{%- if not item.startswith('_') and item not in inherited_members %}

mayp777's avatar
UPDATE  
mayp777 committed
25
{{ item | underline("~") }}
26
27
28
29
30
31
32
33
34

.. container:: py attribute

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

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

mayp777's avatar
UPDATE  
mayp777 committed
35
36
{%- if members %}

37
Methods
mayp777's avatar
UPDATE  
mayp777 committed
38
-------
39
40

{%- for item in members %}
mayp777's avatar
UPDATE  
mayp777 committed
41
42
43
44
45
{%- if
   not item.startswith('_')
   and item not in inherited_members
   and item not in attributes
   %}
46

mayp777's avatar
UPDATE  
mayp777 committed
47
{{ item | underline("~") }}
48
49
50
51
52
53
54

.. container:: py attribute

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

{%- endif %}
{%- endfor %}
mayp777's avatar
UPDATE  
mayp777 committed
55
{%- endif %}
56

mayp777's avatar
UPDATE  
mayp777 committed
57
58

{%- if name in ["StreamReader", "StreamWriter"] %}
59
60

Support Structures
mayp777's avatar
UPDATE  
mayp777 committed
61
------------------
62

mayp777's avatar
UPDATE  
mayp777 committed
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{%- if name == "StreamReader" %}
{%- for item in [
    "ChunkTensor",
    "SourceStream",
    "SourceAudioStream",
    "SourceVideoStream",
    "OutputStream",
    "OutputAudioStream",
    "OutputVideoStream",
] %}

{{ item | underline("~") }}

.. autoclass:: torchaudio.io._stream_reader.{{item}}()
   :members:
78

mayp777's avatar
UPDATE  
mayp777 committed
79
80
81
82
83
84
{%- endfor %}

{%- elif name == "StreamWriter" %}

CodecConfig
~~~~~~~~~~~
85

mayp777's avatar
UPDATE  
mayp777 committed
86
.. autoclass:: torchaudio.io::CodecConfig
87
88
   :members:

mayp777's avatar
UPDATE  
mayp777 committed
89
{%- endif %}
90
{%- endif %}