项目文件夹

文件
Alexandre Défossez (autodoc) aeffa9f270 api_docs
2025-03-13 16:07:03 +00:00

375 行
21 KiB
HTML

此文件含有不可见的 Unicode 字符
此文件含有人类无法区分的不可见的 Unicode 字符,但可以由计算机进行不同的处理。 如果您是想特意这样的,可以安全地忽略该警告。 使用 Escape 按钮显示他们。
此文件含有可能会与其他字符混淆的 Unicode 字符。 如果您是想特意这样的,可以安全地忽略该警告。 使用 Escape 按钮显示他们。
<!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.models.loaders API documentation</title>
<meta name="description" content="Utility functions to load from the checkpoints.
Each checkpoint is a torch.saved dict with the following keys:
- &#39;xp.cfg&#39;: the hydra config as dumped …">
<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.models.loaders</code></h1>
</header>
<section id="section-intro">
<p>Utility functions to load from the checkpoints.
Each checkpoint is a torch.saved dict with the following keys:
- 'xp.cfg': the hydra config as dumped during training. This should be used
to rebuild the object using the audiocraft.models.builders functions,
- 'model_best_state': a readily loadable best state for the model, including
the conditioner. The model obtained from <code>xp.cfg</code> should be compatible
with this state dict. In the case of a LM, the encodec model would not be
bundled along but instead provided separately.</p>
<p>Those functions also support loading from a remote location with the Torch Hub API.
They also support overriding some parameters, in particular the device and dtype
of the returned model.</p>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="audiocraft.models.loaders.get_audiocraft_cache_dir"><code class="name flex">
<span>def <span class="ident">get_audiocraft_cache_dir</span></span>(<span>) > str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_audiocraft_cache_dir() -&gt; tp.Optional[str]:
return os.environ.get(&#39;AUDIOCRAFT_CACHE_DIR&#39;, None)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_audioseal_models"><code class="name flex">
<span>def <span class="ident">load_audioseal_models</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>device='cpu',<br>filename: str | None = None,<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_audioseal_models(
file_or_url_or_id: tp.Union[Path, str],
device=&#34;cpu&#34;,
filename: tp.Optional[str] = None,
cache_dir: tp.Optional[str] = None,
):
detector_ckpt = _get_state_dict(
file_or_url_or_id,
filename=f&#34;detector_{filename}.pth&#34;,
device=device,
cache_dir=cache_dir,
)
assert (
&#34;model&#34; in detector_ckpt
), f&#34;No model state dict found in {file_or_url_or_id}/detector_{filename}.pth&#34;
detector_state = detector_ckpt[&#34;model&#34;]
generator_ckpt = _get_state_dict(
file_or_url_or_id,
filename=f&#34;generator_{filename}.pth&#34;,
device=device,
cache_dir=cache_dir,
)
assert (
&#34;model&#34; in generator_ckpt
), f&#34;No model state dict found in {file_or_url_or_id}/generator_{filename}.pth&#34;
generator_state = generator_ckpt[&#34;model&#34;]
def load_model_config():
if Path(file_or_url_or_id).joinpath(f&#34;{filename}.yaml&#34;).is_file():
return OmegaConf.load(Path(file_or_url_or_id).joinpath(f&#34;{filename}.yaml&#34;))
elif file_or_url_or_id.startswith(&#34;https://&#34;):
import requests # type: ignore
resp = requests.get(f&#34;{file_or_url_or_id}/{filename}.yaml&#34;)
return OmegaConf.create(resp.text)
else:
file = hf_hub_download(
repo_id=file_or_url_or_id,
filename=f&#34;{filename}.yaml&#34;,
cache_dir=cache_dir,
library_name=&#34;audiocraft&#34;,
library_version=audiocraft.__version__,
)
return OmegaConf.load(file)
try:
cfg = load_model_config()
except Exception as exc: # noqa
cfg_fp = (
Path(__file__)
.parents[2]
.joinpath(&#34;config&#34;, &#34;model&#34;, &#34;watermark&#34;, &#34;default.yaml&#34;)
)
cfg = OmegaConf.load(cfg_fp)
OmegaConf.resolve(cfg)
model = builders.get_watermark_model(cfg)
model.generator.load_state_dict(generator_state)
model.detector.load_state_dict(detector_state)
return model.to(device)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_compression_model"><code class="name flex">
<span>def <span class="ident">load_compression_model</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>device='cpu',<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_compression_model(
file_or_url_or_id: tp.Union[Path, str],
device=&#34;cpu&#34;,
cache_dir: tp.Optional[str] = None,
):
pkg = load_compression_model_ckpt(file_or_url_or_id, cache_dir=cache_dir)
if &#39;pretrained&#39; in pkg:
return CompressionModel.get_pretrained(pkg[&#39;pretrained&#39;], device=device)
cfg = OmegaConf.create(pkg[&#39;xp.cfg&#39;])
cfg.device = str(device)
model = builders.get_compression_model(cfg)
model.load_state_dict(pkg[&#34;best_state&#34;])
model.eval()
return model</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_compression_model_ckpt"><code class="name flex">
<span>def <span class="ident">load_compression_model_ckpt</span></span>(<span>file_or_url_or_id: str | pathlib.Path, cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_compression_model_ckpt(file_or_url_or_id: tp.Union[Path, str], cache_dir: tp.Optional[str] = None):
return _get_state_dict(file_or_url_or_id, filename=&#34;compression_state_dict.bin&#34;, cache_dir=cache_dir)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_diffusion_models"><code class="name flex">
<span>def <span class="ident">load_diffusion_models</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>device='cpu',<br>filename: str | None = None,<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_diffusion_models(file_or_url_or_id: tp.Union[Path, str],
device=&#39;cpu&#39;,
filename: tp.Optional[str] = None,
cache_dir: tp.Optional[str] = None):
pkg = load_mbd_ckpt(file_or_url_or_id, filename=filename, cache_dir=cache_dir)
models = []
processors = []
cfgs = []
sample_rate = pkg[&#39;sample_rate&#39;]
for i in range(pkg[&#39;n_bands&#39;]):
cfg = pkg[i][&#39;cfg&#39;]
model = builders.get_diffusion_model(cfg)
model_dict = pkg[i][&#39;model_state&#39;]
model.load_state_dict(model_dict)
model.to(device)
processor = builders.get_processor(cfg=cfg.processor, sample_rate=sample_rate)
processor_dict = pkg[i][&#39;processor_state&#39;]
processor.load_state_dict(processor_dict)
processor.to(device)
models.append(model)
processors.append(processor)
cfgs.append(cfg)
return models, processors, cfgs</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_jasco_model"><code class="name flex">
<span>def <span class="ident">load_jasco_model</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>compression_model: <a title="audiocraft.models.encodec.CompressionModel" href="encodec.html#audiocraft.models.encodec.CompressionModel">CompressionModel</a>,<br>device='cpu',<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_jasco_model(file_or_url_or_id: tp.Union[Path, str],
compression_model: CompressionModel,
device=&#39;cpu&#39;, cache_dir: tp.Optional[str] = None):
pkg = load_lm_model_ckpt(file_or_url_or_id, cache_dir=cache_dir)
cfg = OmegaConf.create(pkg[&#39;xp.cfg&#39;])
cfg.device = str(device)
if cfg.device == &#39;cpu&#39;:
cfg.dtype = &#39;float32&#39;
else:
cfg.dtype = &#39;float16&#39;
model = builders.get_jasco_model(cfg, compression_model)
model.load_state_dict(pkg[&#39;best_state&#39;])
model.eval()
model.cfg = cfg
return model</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_lm_model"><code class="name flex">
<span>def <span class="ident">load_lm_model</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>device='cpu',<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_lm_model(file_or_url_or_id: tp.Union[Path, str], device=&#39;cpu&#39;, cache_dir: tp.Optional[str] = None):
pkg = load_lm_model_ckpt(file_or_url_or_id, cache_dir=cache_dir)
cfg = OmegaConf.create(pkg[&#39;xp.cfg&#39;])
cfg.device = str(device)
if cfg.device == &#39;cpu&#39;:
cfg.dtype = &#39;float32&#39;
else:
cfg.dtype = &#39;float16&#39;
_delete_param(cfg, &#39;conditioners.self_wav.chroma_stem.cache_path&#39;)
_delete_param(cfg, &#39;conditioners.args.merge_text_conditions_p&#39;)
_delete_param(cfg, &#39;conditioners.args.drop_desc_p&#39;)
model = builders.get_lm_model(cfg)
model.load_state_dict(pkg[&#39;best_state&#39;])
model.eval()
model.cfg = cfg
return model</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_lm_model_ckpt"><code class="name flex">
<span>def <span class="ident">load_lm_model_ckpt</span></span>(<span>file_or_url_or_id: str | pathlib.Path, cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_lm_model_ckpt(file_or_url_or_id: tp.Union[Path, str], cache_dir: tp.Optional[str] = None):
return _get_state_dict(file_or_url_or_id, filename=&#34;state_dict.bin&#34;, cache_dir=cache_dir)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_lm_model_magnet"><code class="name flex">
<span>def <span class="ident">load_lm_model_magnet</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>compression_model_frame_rate: int,<br>device='cpu',<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_lm_model_magnet(file_or_url_or_id: tp.Union[Path, str], compression_model_frame_rate: int,
device=&#39;cpu&#39;, cache_dir: tp.Optional[str] = None):
pkg = load_lm_model_ckpt(file_or_url_or_id, cache_dir=cache_dir)
cfg = OmegaConf.create(pkg[&#39;xp.cfg&#39;])
cfg.device = str(device)
if cfg.device == &#39;cpu&#39;:
cfg.dtype = &#39;float32&#39;
else:
cfg.dtype = &#39;float16&#39;
_delete_param(cfg, &#39;conditioners.args.merge_text_conditions_p&#39;)
_delete_param(cfg, &#39;conditioners.args.drop_desc_p&#39;)
cfg.transformer_lm.compression_model_framerate = compression_model_frame_rate
cfg.transformer_lm.segment_duration = cfg.dataset.segment_duration
cfg.transformer_lm.span_len = cfg.masking.span_len
# MAGNeT models v1 support only xformers backend.
from audiocraft.modules.transformer import set_efficient_attention_backend
if cfg.transformer_lm.memory_efficient:
set_efficient_attention_backend(&#34;xformers&#34;)
model = builders.get_lm_model(cfg)
model.load_state_dict(pkg[&#39;best_state&#39;])
model.eval()
model.cfg = cfg
return model</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="audiocraft.models.loaders.load_mbd_ckpt"><code class="name flex">
<span>def <span class="ident">load_mbd_ckpt</span></span>(<span>file_or_url_or_id: str | pathlib.Path,<br>filename: str | None = None,<br>cache_dir: str | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_mbd_ckpt(file_or_url_or_id: tp.Union[Path, str],
filename: tp.Optional[str] = None,
cache_dir: tp.Optional[str] = None):
return _get_state_dict(file_or_url_or_id, filename=filename, cache_dir=cache_dir)</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</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.models" href="index.html">audiocraft.models</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="audiocraft.models.loaders.get_audiocraft_cache_dir" href="#audiocraft.models.loaders.get_audiocraft_cache_dir">get_audiocraft_cache_dir</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_audioseal_models" href="#audiocraft.models.loaders.load_audioseal_models">load_audioseal_models</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_compression_model" href="#audiocraft.models.loaders.load_compression_model">load_compression_model</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_compression_model_ckpt" href="#audiocraft.models.loaders.load_compression_model_ckpt">load_compression_model_ckpt</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_diffusion_models" href="#audiocraft.models.loaders.load_diffusion_models">load_diffusion_models</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_jasco_model" href="#audiocraft.models.loaders.load_jasco_model">load_jasco_model</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_lm_model" href="#audiocraft.models.loaders.load_lm_model">load_lm_model</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_lm_model_ckpt" href="#audiocraft.models.loaders.load_lm_model_ckpt">load_lm_model_ckpt</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_lm_model_magnet" href="#audiocraft.models.loaders.load_lm_model_magnet">load_lm_model_magnet</a></code></li>
<li><code><a title="audiocraft.models.loaders.load_mbd_ckpt" href="#audiocraft.models.loaders.load_mbd_ckpt">load_mbd_ckpt</a></code></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>