facebookresearch--audiocraft
440 行
24 KiB
HTML
440 行
24 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
|
||
<meta name="generator" content="pdoc3 0.11.5">
|
||
<title>audiocraft.modules.streaming API documentation</title>
|
||
<meta name="description" content="Streaming module API that should be implemented by all Streaming components,">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
|
||
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
|
||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
|
||
<script>window.addEventListener('DOMContentLoaded', () => {
|
||
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
|
||
hljs.highlightAll();
|
||
/* Collapse source docstrings */
|
||
setTimeout(() => {
|
||
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
|
||
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
|
||
.forEach(el => {
|
||
let d = document.createElement('details');
|
||
d.classList.add('hljs-string');
|
||
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
|
||
el.replaceWith(d);
|
||
});
|
||
}, 100);
|
||
})</script>
|
||
</head>
|
||
<body>
|
||
<main>
|
||
<article id="content">
|
||
<header>
|
||
<h1 class="title">Module <code>audiocraft.modules.streaming</code></h1>
|
||
</header>
|
||
<section id="section-intro">
|
||
<p>Streaming module API that should be implemented by all Streaming components,</p>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
<h2 class="section-title" id="header-classes">Classes</h2>
|
||
<dl>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule"><code class="flex name class">
|
||
<span>class <span class="ident">StreamingModule</span></span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class StreamingModule(nn.Module):
|
||
"""Common API for streaming components.
|
||
|
||
Each streaming component has a streaming state, which is just a dict[str, Tensor].
|
||
By convention, the first dim of each tensor must be the batch size.
|
||
Don't use dots in the key names, as this would clash with submodules
|
||
(like in state_dict).
|
||
|
||
If `self._is_streaming` is True, the component should use and remember
|
||
the proper state inside `self._streaming_state`.
|
||
|
||
To set a streaming component in streaming state, use
|
||
|
||
with module.streaming():
|
||
...
|
||
|
||
This will automatically reset the streaming state when exiting the context manager.
|
||
This also automatically propagates to all streaming children module.
|
||
|
||
Some module might also implement the `StreamingModule.flush` method, although
|
||
this one is trickier, as all parents module must be StreamingModule and implement
|
||
it as well for it to work properly. See `StreamingSequential` after.
|
||
"""
|
||
def __init__(self) -> None:
|
||
super().__init__()
|
||
self._streaming_state: State = {}
|
||
self._is_streaming = False
|
||
|
||
def _apply_named_streaming(self, fn: tp.Any):
|
||
for name, module in self.named_modules():
|
||
if isinstance(module, StreamingModule):
|
||
fn(name, module)
|
||
|
||
def _set_streaming(self, streaming: bool):
|
||
def _set_streaming(name, module):
|
||
module._is_streaming = streaming
|
||
self._apply_named_streaming(_set_streaming)
|
||
|
||
@contextmanager
|
||
def streaming(self):
|
||
"""Context manager to enter streaming mode. Reset streaming state on exit."""
|
||
self._set_streaming(True)
|
||
try:
|
||
yield
|
||
finally:
|
||
self._set_streaming(False)
|
||
self.reset_streaming()
|
||
|
||
def reset_streaming(self):
|
||
"""Reset the streaming state."""
|
||
def _reset(name: str, module: StreamingModule):
|
||
module._streaming_state.clear()
|
||
|
||
self._apply_named_streaming(_reset)
|
||
|
||
def get_streaming_state(self) -> State:
|
||
"""Return the streaming state, including that of sub-modules."""
|
||
state: State = {}
|
||
|
||
def _add(name: str, module: StreamingModule):
|
||
if name:
|
||
name += "."
|
||
for key, value in module._streaming_state.items():
|
||
state[name + key] = value
|
||
|
||
self._apply_named_streaming(_add)
|
||
return state
|
||
|
||
def set_streaming_state(self, state: State):
|
||
"""Set the streaming state, including that of sub-modules."""
|
||
state = dict(state)
|
||
|
||
def _set(name: str, module: StreamingModule):
|
||
if name:
|
||
name += "."
|
||
module._streaming_state.clear()
|
||
for key, value in list(state.items()):
|
||
# complexity is not ideal here, but probably fine.
|
||
if key.startswith(name):
|
||
local_key = key[len(name):]
|
||
if '.' not in local_key:
|
||
module._streaming_state[local_key] = value
|
||
del state[key]
|
||
|
||
self._apply_named_streaming(_set)
|
||
assert len(state) == 0, list(state.keys())
|
||
|
||
def flush(self, x: tp.Optional[torch.Tensor] = None):
|
||
"""Flush any remaining outputs that were waiting for completion.
|
||
Typically, for convolutions, this will add the final padding
|
||
and process the last buffer.
|
||
|
||
This should take an optional argument `x`, which will be provided
|
||
if a module before this one in the streaming pipeline has already
|
||
spitted out a flushed out buffer.
|
||
"""
|
||
if x is None:
|
||
return None
|
||
else:
|
||
return self(x)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Common API for streaming components.</p>
|
||
<p>Each streaming component has a streaming state, which is just a dict[str, Tensor].
|
||
By convention, the first dim of each tensor must be the batch size.
|
||
Don't use dots in the key names, as this would clash with submodules
|
||
(like in state_dict).</p>
|
||
<p>If <code>self._is_streaming</code> is True, the component should use and remember
|
||
the proper state inside <code>self._streaming_state</code>.</p>
|
||
<p>To set a streaming component in streaming state, use</p>
|
||
<pre><code>with module.streaming():
|
||
...
|
||
</code></pre>
|
||
<p>This will automatically reset the streaming state when exiting the context manager.
|
||
This also automatically propagates to all streaming children module.</p>
|
||
<p>Some module might also implement the <code><a title="audiocraft.modules.streaming.StreamingModule.flush" href="#audiocraft.modules.streaming.StreamingModule.flush">StreamingModule.flush()</a></code> method, although
|
||
this one is trickier, as all parents module must be StreamingModule and implement
|
||
it as well for it to work properly. See <code><a title="audiocraft.modules.streaming.StreamingSequential" href="#audiocraft.modules.streaming.StreamingSequential">StreamingSequential</a></code> after.</p>
|
||
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li>torch.nn.modules.module.Module</li>
|
||
</ul>
|
||
<h3>Subclasses</h3>
|
||
<ul class="hlist">
|
||
<li><a title="audiocraft.models.flow_matching.FlowMatchingModel" href="../models/flow_matching.html#audiocraft.models.flow_matching.FlowMatchingModel">FlowMatchingModel</a></li>
|
||
<li><a title="audiocraft.models.lm.LMModel" href="../models/lm.html#audiocraft.models.lm.LMModel">LMModel</a></li>
|
||
<li><a title="audiocraft.modules.conditioners.ConditionFuser" href="conditioners.html#audiocraft.modules.conditioners.ConditionFuser">ConditionFuser</a></li>
|
||
<li><a title="audiocraft.modules.streaming.StreamingSequential" href="#audiocraft.modules.streaming.StreamingSequential">StreamingSequential</a></li>
|
||
<li><a title="audiocraft.modules.transformer.StreamingMultiheadAttention" href="transformer.html#audiocraft.modules.transformer.StreamingMultiheadAttention">StreamingMultiheadAttention</a></li>
|
||
<li><a title="audiocraft.modules.transformer.StreamingTransformer" href="transformer.html#audiocraft.modules.transformer.StreamingTransformer">StreamingTransformer</a></li>
|
||
</ul>
|
||
<h3>Class variables</h3>
|
||
<dl>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.call_super_init"><code class="name">var <span class="ident">call_super_init</span> : bool</code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.dump_patches"><code class="name">var <span class="ident">dump_patches</span> : bool</code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.training"><code class="name">var <span class="ident">training</span> : bool</code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
</dl>
|
||
<h3>Methods</h3>
|
||
<dl>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.flush"><code class="name flex">
|
||
<span>def <span class="ident">flush</span></span>(<span>self, x: torch.Tensor | None = None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def flush(self, x: tp.Optional[torch.Tensor] = None):
|
||
"""Flush any remaining outputs that were waiting for completion.
|
||
Typically, for convolutions, this will add the final padding
|
||
and process the last buffer.
|
||
|
||
This should take an optional argument `x`, which will be provided
|
||
if a module before this one in the streaming pipeline has already
|
||
spitted out a flushed out buffer.
|
||
"""
|
||
if x is None:
|
||
return None
|
||
else:
|
||
return self(x)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Flush any remaining outputs that were waiting for completion.
|
||
Typically, for convolutions, this will add the final padding
|
||
and process the last buffer.</p>
|
||
<p>This should take an optional argument <code>x</code>, which will be provided
|
||
if a module before this one in the streaming pipeline has already
|
||
spitted out a flushed out buffer.</p></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.forward"><code class="name flex">
|
||
<span>def <span class="ident">forward</span></span>(<span>self, *input: Any) ‑> None</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def _forward_unimplemented(self, *input: Any) -> None:
|
||
r"""Defines the computation performed at every call.
|
||
|
||
Should be overridden by all subclasses.
|
||
|
||
.. note::
|
||
Although the recipe for forward pass needs to be defined within
|
||
this function, one should call the :class:`Module` instance afterwards
|
||
instead of this since the former takes care of running the
|
||
registered hooks while the latter silently ignores them.
|
||
"""
|
||
raise NotImplementedError(f"Module [{type(self).__name__}] is missing the required \"forward\" function")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Defines the computation performed at every call.</p>
|
||
<p>Should be overridden by all subclasses.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Although the recipe for forward pass needs to be defined within
|
||
this function, one should call the :class:<code>Module</code> instance afterwards
|
||
instead of this since the former takes care of running the
|
||
registered hooks while the latter silently ignores them.</p>
|
||
</div></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.get_streaming_state"><code class="name flex">
|
||
<span>def <span class="ident">get_streaming_state</span></span>(<span>self) ‑> Dict[str, torch.Tensor]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_streaming_state(self) -> State:
|
||
"""Return the streaming state, including that of sub-modules."""
|
||
state: State = {}
|
||
|
||
def _add(name: str, module: StreamingModule):
|
||
if name:
|
||
name += "."
|
||
for key, value in module._streaming_state.items():
|
||
state[name + key] = value
|
||
|
||
self._apply_named_streaming(_add)
|
||
return state</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return the streaming state, including that of sub-modules.</p></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.reset_streaming"><code class="name flex">
|
||
<span>def <span class="ident">reset_streaming</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def reset_streaming(self):
|
||
"""Reset the streaming state."""
|
||
def _reset(name: str, module: StreamingModule):
|
||
module._streaming_state.clear()
|
||
|
||
self._apply_named_streaming(_reset)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Reset the streaming state.</p></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.set_streaming_state"><code class="name flex">
|
||
<span>def <span class="ident">set_streaming_state</span></span>(<span>self, state: Dict[str, torch.Tensor])</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def set_streaming_state(self, state: State):
|
||
"""Set the streaming state, including that of sub-modules."""
|
||
state = dict(state)
|
||
|
||
def _set(name: str, module: StreamingModule):
|
||
if name:
|
||
name += "."
|
||
module._streaming_state.clear()
|
||
for key, value in list(state.items()):
|
||
# complexity is not ideal here, but probably fine.
|
||
if key.startswith(name):
|
||
local_key = key[len(name):]
|
||
if '.' not in local_key:
|
||
module._streaming_state[local_key] = value
|
||
del state[key]
|
||
|
||
self._apply_named_streaming(_set)
|
||
assert len(state) == 0, list(state.keys())</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Set the streaming state, including that of sub-modules.</p></div>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingModule.streaming"><code class="name flex">
|
||
<span>def <span class="ident">streaming</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">@contextmanager
|
||
def streaming(self):
|
||
"""Context manager to enter streaming mode. Reset streaming state on exit."""
|
||
self._set_streaming(True)
|
||
try:
|
||
yield
|
||
finally:
|
||
self._set_streaming(False)
|
||
self.reset_streaming()</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Context manager to enter streaming mode. Reset streaming state on exit.</p></div>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dt id="audiocraft.modules.streaming.StreamingSequential"><code class="flex name class">
|
||
<span>class <span class="ident">StreamingSequential</span></span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class StreamingSequential(StreamingModule, nn.Sequential):
|
||
"""A streaming compatible alternative of `nn.Sequential`.
|
||
"""
|
||
def flush(self, x: tp.Optional[torch.Tensor] = None):
|
||
for module in self:
|
||
if isinstance(module, StreamingModule):
|
||
x = module.flush(x)
|
||
elif x is not None:
|
||
x = module(x)
|
||
return x</code></pre>
|
||
</details>
|
||
<div class="desc"><p>A streaming compatible alternative of <code>nn.Sequential</code>.</p>
|
||
<p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="audiocraft.modules.streaming.StreamingModule" href="#audiocraft.modules.streaming.StreamingModule">StreamingModule</a></li>
|
||
<li>torch.nn.modules.container.Sequential</li>
|
||
<li>torch.nn.modules.module.Module</li>
|
||
</ul>
|
||
<h3>Inherited members</h3>
|
||
<ul class="hlist">
|
||
<li><code><b><a title="audiocraft.modules.streaming.StreamingModule" href="#audiocraft.modules.streaming.StreamingModule">StreamingModule</a></b></code>:
|
||
<ul class="hlist">
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.flush" href="#audiocraft.modules.streaming.StreamingModule.flush">flush</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.forward" href="#audiocraft.modules.streaming.StreamingModule.forward">forward</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.get_streaming_state" href="#audiocraft.modules.streaming.StreamingModule.get_streaming_state">get_streaming_state</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.reset_streaming" href="#audiocraft.modules.streaming.StreamingModule.reset_streaming">reset_streaming</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.set_streaming_state" href="#audiocraft.modules.streaming.StreamingModule.set_streaming_state">set_streaming_state</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.streaming" href="#audiocraft.modules.streaming.StreamingModule.streaming">streaming</a></code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</article>
|
||
<nav id="sidebar">
|
||
<div class="toc">
|
||
<ul></ul>
|
||
</div>
|
||
<ul id="index">
|
||
<li><h3>Super-module</h3>
|
||
<ul>
|
||
<li><code><a title="audiocraft.modules" href="index.html">audiocraft.modules</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li><h3><a href="#header-classes">Classes</a></h3>
|
||
<ul>
|
||
<li>
|
||
<h4><code><a title="audiocraft.modules.streaming.StreamingModule" href="#audiocraft.modules.streaming.StreamingModule">StreamingModule</a></code></h4>
|
||
<ul class="two-column">
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.call_super_init" href="#audiocraft.modules.streaming.StreamingModule.call_super_init">call_super_init</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.dump_patches" href="#audiocraft.modules.streaming.StreamingModule.dump_patches">dump_patches</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.flush" href="#audiocraft.modules.streaming.StreamingModule.flush">flush</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.forward" href="#audiocraft.modules.streaming.StreamingModule.forward">forward</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.get_streaming_state" href="#audiocraft.modules.streaming.StreamingModule.get_streaming_state">get_streaming_state</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.reset_streaming" href="#audiocraft.modules.streaming.StreamingModule.reset_streaming">reset_streaming</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.set_streaming_state" href="#audiocraft.modules.streaming.StreamingModule.set_streaming_state">set_streaming_state</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.streaming" href="#audiocraft.modules.streaming.StreamingModule.streaming">streaming</a></code></li>
|
||
<li><code><a title="audiocraft.modules.streaming.StreamingModule.training" href="#audiocraft.modules.streaming.StreamingModule.training">training</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="audiocraft.modules.streaming.StreamingSequential" href="#audiocraft.modules.streaming.StreamingSequential">StreamingSequential</a></code></h4>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</main>
|
||
<footer id="footer">
|
||
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
|
||
</footer>
|
||
</body>
|
||
</html>
|