Skip to content
Snippets Groups Projects
Commit 87e94db9 authored by Documenter.jl's avatar Documenter.jl
Browse files

build based on 5d8b5d6a

parent 6c6097f0
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
dev/.documenter-siteinfo.json
+ 1
− 1
View file @ 87e94db9
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-10-21T15:45:36","documenter_version":"1.7.0"}} {"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-10-21T16:07:09","documenter_version":"1.7.0"}}
\ No newline at end of file \ No newline at end of file
dev/api/index.html
+ 7
− 7
View file @ 87e94db9
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · SpeechDatasets</title><meta name="title" content="API · SpeechDatasets"/><meta property="og:title" content="API · SpeechDatasets"/><meta property="twitter:title" content="API · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../installation/">Installation</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Load-a-Dataset"><span>Load a Dataset</span></a></li><li><a class="tocitem" href="#Types"><span>Types</span></a></li><li><a class="tocitem" href="#Lexicons"><span>Lexicons</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/api.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="Load-a-Dataset"><a class="docs-heading-anchor" href="#Load-a-Dataset">Load a Dataset</a><a id="Load-a-Dataset-1"></a><a class="docs-heading-anchor-permalink" href="#Load-a-Dataset" title="Permalink"></a></h2><p>To get data from a supported dataset, you only need one function:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.dataset" href="#SpeechDatasets.dataset"><code>SpeechDatasets.dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dataset(dataset, inputdir::AbstractString, outputdir::AbstractString; kwargs...)</code></pre><p>Create a <a href="#SpeechDataset"><code>SpeechDataset</code></a> object for <code>dataset</code>. <code>inputdir</code> is the directory containing the raw data. If the <code>inputdir</code> does not exist and the data is freely available, it will be automatically downloaded and put in <code>inputdir</code>. <code>outputdir</code> is the directory where will be stored summary files. <code>kwargs</code>... are dataset specific arguments passed to <code>dataset</code></p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/dataset.jl#L74-L82">source</a></section></article><h2 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h2><h3 id="SpeechDataset"><a class="docs-heading-anchor" href="#SpeechDataset">SpeechDataset</a><a id="SpeechDataset-1"></a><a class="docs-heading-anchor-permalink" href="#SpeechDataset" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.SpeechDataset" href="#SpeechDatasets.SpeechDataset"><code>SpeechDatasets.SpeechDataset</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">SpeechDataset</code></pre><p>Store metadata about a speech dataset.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/dataset.jl#L4-L8">source</a></section></article><p>Access a single element with integer or id indexing</p><pre><code class="language-julia hljs"># ds::SpeechDataset <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · SpeechDatasets</title><meta name="title" content="API · SpeechDatasets"/><meta property="og:title" content="API · SpeechDatasets"/><meta property="twitter:title" content="API · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../installation/">Installation</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Load-a-Dataset"><span>Load a Dataset</span></a></li><li><a class="tocitem" href="#Types"><span>Types</span></a></li><li><a class="tocitem" href="#Lexicons"><span>Lexicons</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/api.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="Load-a-Dataset"><a class="docs-heading-anchor" href="#Load-a-Dataset">Load a Dataset</a><a id="Load-a-Dataset-1"></a><a class="docs-heading-anchor-permalink" href="#Load-a-Dataset" title="Permalink"></a></h2><p>To get data from a supported dataset, you only need one function:</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.dataset" href="#SpeechDatasets.dataset"><code>SpeechDatasets.dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">dataset(dataset, inputdir::AbstractString, outputdir::AbstractString; kwargs...)</code></pre><p>Create a <a href="#SpeechDataset"><code>SpeechDataset</code></a> object for <code>dataset</code>. <code>inputdir</code> is the directory containing the raw data. If the <code>inputdir</code> does not exist and the data is freely available, it will be automatically downloaded and put in <code>inputdir</code>. <code>outputdir</code> is the directory where will be stored summary files. <code>kwargs</code>... are dataset specific arguments passed to <code>dataset</code></p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/dataset.jl#L74-L82">source</a></section></article><h2 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h2><h3 id="SpeechDataset"><a class="docs-heading-anchor" href="#SpeechDataset">SpeechDataset</a><a id="SpeechDataset-1"></a><a class="docs-heading-anchor-permalink" href="#SpeechDataset" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.SpeechDataset" href="#SpeechDatasets.SpeechDataset"><code>SpeechDatasets.SpeechDataset</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">SpeechDataset</code></pre><p>Store metadata about a speech dataset.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/dataset.jl#L4-L8">source</a></section></article><p>Access a single element with integer or id indexing</p><pre><code class="language-julia hljs"># ds::SpeechDataset
ds[1] ds[1]
ds[&quot;1988-147956-0027&quot;]</code></pre><h3 id="Manifest-items"><a class="docs-heading-anchor" href="#Manifest-items">Manifest items</a><a id="Manifest-items-1"></a><a class="docs-heading-anchor-permalink" href="#Manifest-items" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.ManifestItem" href="#SpeechDatasets.ManifestItem"><code>SpeechDatasets.ManifestItem</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abstract type ManifestItem end</code></pre><p>Base class for all manifest item. Every manifest item should have an <code>id</code> attribute.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_item.jl#L3-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.Recording" href="#SpeechDatasets.Recording"><code>SpeechDatasets.Recording</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct Recording{Ts&lt;:AbstractAudioSource} &lt;: ManifestItem ds[&quot;1988-147956-0027&quot;]</code></pre><h3 id="Manifest-items"><a class="docs-heading-anchor" href="#Manifest-items">Manifest items</a><a id="Manifest-items-1"></a><a class="docs-heading-anchor-permalink" href="#Manifest-items" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.ManifestItem" href="#SpeechDatasets.ManifestItem"><code>SpeechDatasets.ManifestItem</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">abstract type ManifestItem end</code></pre><p>Base class for all manifest item. Every manifest item should have an <code>id</code> attribute.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_item.jl#L3-L8">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.Recording" href="#SpeechDatasets.Recording"><code>SpeechDatasets.Recording</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct Recording{Ts&lt;:AbstractAudioSource} &lt;: ManifestItem
id::AbstractString id::AbstractString
source::Ts source::Ts
channels::Vector{Int} channels::Vector{Int}
samplerate::Int samplerate::Int
end</code></pre><p>A recording is an audio source associated with and id.</p><p><strong>Constructors</strong></p><pre><code class="nohighlight hljs">Recording(id, source, channels, samplerate) end</code></pre><p>A recording is an audio source associated with and id.</p><p><strong>Constructors</strong></p><pre><code class="nohighlight hljs">Recording(id, source, channels, samplerate)
Recording(id, source[; channels = missing, samplerate = missing])</code></pre><p>If the channels or the sample rate are not provided then they will be read from <code>source</code>.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>When preparing large corpus, not providing the channels and/or the sample rate can drastically reduce the speed as it forces to read source.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_item.jl#L11-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.Annotation" href="#SpeechDatasets.Annotation"><code>SpeechDatasets.Annotation</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct Annotation &lt;: ManifestItem Recording(id, source[; channels = missing, samplerate = missing])</code></pre><p>If the channels or the sample rate are not provided then they will be read from <code>source</code>.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>When preparing large corpus, not providing the channels and/or the sample rate can drastically reduce the speed as it forces to read source.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_item.jl#L11-L32">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.Annotation" href="#SpeechDatasets.Annotation"><code>SpeechDatasets.Annotation</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">struct Annotation &lt;: ManifestItem
id::AbstractString id::AbstractString
recording_id::AbstractString recording_id::AbstractString
start::Float64 start::Float64
...@@ -15,7 +15,7 @@ Recording(id, source[; channels = missing, samplerate = missing])</code></pre><p ...@@ -15,7 +15,7 @@ Recording(id, source[; channels = missing, samplerate = missing])</code></pre><p
channel::Union{Vector, Colon} channel::Union{Vector, Colon}
data::Dict data::Dict
end</code></pre><p>An &quot;annotation&quot; defines a segment of a recording on a single channel. The <code>data</code> field is an arbitrary dictionary holdin the nature of the annotation. <code>start</code> and <code>duration</code> (in seconds) defines, where the segment is locatated within the recoding <code>recording_id</code>.</p><p><strong>Constructor</strong></p><pre><code class="nohighlight hljs">Annotation(id, recording_id, start, duration, channel, data) end</code></pre><p>An &quot;annotation&quot; defines a segment of a recording on a single channel. The <code>data</code> field is an arbitrary dictionary holdin the nature of the annotation. <code>start</code> and <code>duration</code> (in seconds) defines, where the segment is locatated within the recoding <code>recording_id</code>.</p><p><strong>Constructor</strong></p><pre><code class="nohighlight hljs">Annotation(id, recording_id, start, duration, channel, data)
Annotation(id, recording_id[; channel = missing, start = -1, duration = -1, data = missing)</code></pre><p>If <code>start</code> and/or <code>duration</code> are negative, the segment is considered to be the whole sequence length of the recording.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_item.jl#L49-L71">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="AudioSources.load-Tuple{Recording}" href="#AudioSources.load-Tuple{Recording}"><code>AudioSources.load</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load(recording::Recording [; start = -1, duration = -1, channels = recording.channels]) Annotation(id, recording_id[; channel = missing, start = -1, duration = -1, data = missing)</code></pre><p>If <code>start</code> and/or <code>duration</code> are negative, the segment is considered to be the whole sequence length of the recording.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_item.jl#L49-L71">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="AudioSources.load-Tuple{Recording}" href="#AudioSources.load-Tuple{Recording}"><code>AudioSources.load</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load(recording::Recording [; start = -1, duration = -1, channels = recording.channels])
load(recording, annotation)</code></pre><p>Load the signal from a recording. <code>start</code>, <code>duration</code> (in seconds)</p><p>The function returns a tuple <code>(x, sr)</code> where <code>x</code> is a <span>$N×C$</span> array</p><ul><li><span>$N$</span> is the length of the signal and <span>$C$</span> is the number of channels</li><li>and <code>sr</code> is the sampling rate of the signal.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_item.jl#L85-L94">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="AudioSources.load-Tuple{Recording, Annotation}" href="#AudioSources.load-Tuple{Recording, Annotation}"><code>AudioSources.load</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load(r::Recording, a::Annotation) load(recording, annotation)</code></pre><p>Load the signal from a recording. <code>start</code>, <code>duration</code> (in seconds)</p><p>The function returns a tuple <code>(x, sr)</code> where <code>x</code> is a <span>$N×C$</span> array</p><ul><li><span>$N$</span> is the length of the signal and <span>$C$</span> is the number of channels</li><li>and <code>sr</code> is the sampling rate of the signal.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_item.jl#L85-L94">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="AudioSources.load-Tuple{Recording, Annotation}" href="#AudioSources.load-Tuple{Recording, Annotation}"><code>AudioSources.load</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load(r::Recording, a::Annotation)
load(t::Tuple{Recording, Annotation})</code></pre><p>Load only a segment of the recording referenced in the annotation.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_item.jl#L107-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}" href="#SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}"><code>SpeechDatasets.load_manifest</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load_manifest(Annotation, path) load(t::Tuple{Recording, Annotation})</code></pre><p>Load only a segment of the recording referenced in the annotation.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_item.jl#L107-L111">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}" href="#SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}"><code>SpeechDatasets.load_manifest</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">load_manifest(Annotation, path)
load_manifest(Recording, path)</code></pre><p>Load Recording/Annotation manifest from <code>path</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/manifest_io.jl#L131-L136">source</a></section></article><h2 id="Lexicons"><a class="docs-heading-anchor" href="#Lexicons">Lexicons</a><a id="Lexicons-1"></a><a class="docs-heading-anchor-permalink" href="#Lexicons" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.CMUDICT-Tuple{Any}" href="#SpeechDatasets.CMUDICT-Tuple{Any}"><code>SpeechDatasets.CMUDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">CMUDICT(path)</code></pre><p>Return the dictionary of pronunciation loaded from the CMU sphinx dictionary. The CMU dictionary will be donwloaded and stored into to <code>path</code>. Subsequent calls will only read the file <code>path</code> without downloading again the data.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/lexicons.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.TIMITDICT-Tuple{Any}" href="#SpeechDatasets.TIMITDICT-Tuple{Any}"><code>SpeechDatasets.TIMITDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TIMITDICT(timitdir)</code></pre><p>Return the dictionary of pronunciation as provided by TIMIT corpus (located in <code>timitdir</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/lexicons.jl#L47-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.MFAFRDICT-Tuple{Any}" href="#SpeechDatasets.MFAFRDICT-Tuple{Any}"><code>SpeechDatasets.MFAFRDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MFAFRDICT(path)</code></pre><p>Return the french dictionary of pronunciation as provided by MFA (french_mfa v2.0.0a).</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/9b31583a77a0d6d42b17ccabe0ae1c19cb945bdc/src/lexicons.jl#L76-L80">source</a></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#SpeechDatasets.Annotation"><code>SpeechDatasets.Annotation</code></a></li><li><a href="#SpeechDatasets.ManifestItem"><code>SpeechDatasets.ManifestItem</code></a></li><li><a href="#SpeechDatasets.Recording"><code>SpeechDatasets.Recording</code></a></li><li><a href="#SpeechDatasets.SpeechDataset"><code>SpeechDatasets.SpeechDataset</code></a></li><li><a href="#AudioSources.load-Tuple{Recording}"><code>AudioSources.load</code></a></li><li><a href="#AudioSources.load-Tuple{Recording, Annotation}"><code>AudioSources.load</code></a></li><li><a href="#SpeechDatasets.CMUDICT-Tuple{Any}"><code>SpeechDatasets.CMUDICT</code></a></li><li><a href="#SpeechDatasets.MFAFRDICT-Tuple{Any}"><code>SpeechDatasets.MFAFRDICT</code></a></li><li><a href="#SpeechDatasets.TIMITDICT-Tuple{Any}"><code>SpeechDatasets.TIMITDICT</code></a></li><li><a href="#SpeechDatasets.dataset"><code>SpeechDatasets.dataset</code></a></li><li><a href="#SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}"><code>SpeechDatasets.load_manifest</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 15:45">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> load_manifest(Recording, path)</code></pre><p>Load Recording/Annotation manifest from <code>path</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/manifest_io.jl#L131-L136">source</a></section></article><h2 id="Lexicons"><a class="docs-heading-anchor" href="#Lexicons">Lexicons</a><a id="Lexicons-1"></a><a class="docs-heading-anchor-permalink" href="#Lexicons" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.CMUDICT-Tuple{Any}" href="#SpeechDatasets.CMUDICT-Tuple{Any}"><code>SpeechDatasets.CMUDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">CMUDICT(path)</code></pre><p>Return the dictionary of pronunciation loaded from the CMU sphinx dictionary. The CMU dictionary will be donwloaded and stored into to <code>path</code>. Subsequent calls will only read the file <code>path</code> without downloading again the data.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/lexicons.jl#L16-L22">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.TIMITDICT-Tuple{Any}" href="#SpeechDatasets.TIMITDICT-Tuple{Any}"><code>SpeechDatasets.TIMITDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">TIMITDICT(timitdir)</code></pre><p>Return the dictionary of pronunciation as provided by TIMIT corpus (located in <code>timitdir</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/lexicons.jl#L47-L52">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SpeechDatasets.MFAFRDICT-Tuple{Any}" href="#SpeechDatasets.MFAFRDICT-Tuple{Any}"><code>SpeechDatasets.MFAFRDICT</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MFAFRDICT(path)</code></pre><p>Return the french dictionary of pronunciation as provided by MFA (french_mfa v2.0.0a).</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/5d8b5d6a3f1e59e0c345ad76809329f6a54c6bb1/src/lexicons.jl#L76-L80">source</a></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#SpeechDatasets.Annotation"><code>SpeechDatasets.Annotation</code></a></li><li><a href="#SpeechDatasets.ManifestItem"><code>SpeechDatasets.ManifestItem</code></a></li><li><a href="#SpeechDatasets.Recording"><code>SpeechDatasets.Recording</code></a></li><li><a href="#SpeechDatasets.SpeechDataset"><code>SpeechDatasets.SpeechDataset</code></a></li><li><a href="#AudioSources.load-Tuple{Recording, Annotation}"><code>AudioSources.load</code></a></li><li><a href="#AudioSources.load-Tuple{Recording}"><code>AudioSources.load</code></a></li><li><a href="#SpeechDatasets.CMUDICT-Tuple{Any}"><code>SpeechDatasets.CMUDICT</code></a></li><li><a href="#SpeechDatasets.MFAFRDICT-Tuple{Any}"><code>SpeechDatasets.MFAFRDICT</code></a></li><li><a href="#SpeechDatasets.TIMITDICT-Tuple{Any}"><code>SpeechDatasets.TIMITDICT</code></a></li><li><a href="#SpeechDatasets.dataset"><code>SpeechDatasets.dataset</code></a></li><li><a href="#SpeechDatasets.load_manifest-Tuple{Type{&lt;:Union{Annotation, Recording}}, Any}"><code>SpeechDatasets.load_manifest</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 16:07">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
dev/examples/index.html
+ 1
− 1
View file @ 87e94db9
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Examples · SpeechDatasets</title><meta name="title" content="Examples · SpeechDatasets"/><meta property="og:title" content="Examples · SpeechDatasets"/><meta property="twitter:title" content="Examples · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../installation/">Installation</a></li><li class="is-active"><a class="tocitem" href>Examples</a></li><li><a class="tocitem" href="../api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Examples</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Examples</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/examples.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h1><pre><code class="language-julia hljs">using SpeechDatasets <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Examples · SpeechDatasets</title><meta name="title" content="Examples · SpeechDatasets"/><meta property="og:title" content="Examples · SpeechDatasets"/><meta property="twitter:title" content="Examples · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../installation/">Installation</a></li><li class="is-active"><a class="tocitem" href>Examples</a></li><li><a class="tocitem" href="../api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Examples</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Examples</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/examples.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h1><pre><code class="language-julia hljs">using SpeechDatasets
ds = dataset(:TIMIT, &quot;path/to/timit&quot;, &quot;outputdir/timit&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../installation/">« Installation</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 15:45">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> ds = dataset(:TIMIT, &quot;path/to/timit&quot;, &quot;outputdir/timit&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../installation/">« Installation</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 16:07">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
dev/index.html
+ 1
− 1
View file @ 87e94db9
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SpeechDatasets</title><meta name="title" content="Home · SpeechDatasets"/><meta property="og:title" content="Home · SpeechDatasets"/><meta property="twitter:title" content="Home · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#License"><span>License</span></a></li><li><a class="tocitem" href="#Authors"><span>Authors</span></a></li></ul></li><li><a class="tocitem" href="installation/">Installation</a></li><li><a class="tocitem" href="examples/">Examples</a></li><li><a class="tocitem" href="api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/index.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="SpeechDatasets.jl"><a class="docs-heading-anchor" href="#SpeechDatasets.jl">SpeechDatasets.jl</a><a id="SpeechDatasets.jl-1"></a><a class="docs-heading-anchor-permalink" href="#SpeechDatasets.jl" title="Permalink"></a></h1><p>Convenient and unified way to load a speech dataset. It can then be harnessed with other PTAL tools. </p><p>A <code>SpeechDataset</code> instance consists of a set of recordings (info about audio data) and annotations.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="#SpeechDatasets.jl">SpeechDatasets.jl</a></li><li class="no-marker"><ul><li><a href="#Contents">Contents</a></li><li><a href="#License">License</a></li><li><a href="#Authors">Authors</a></li></ul></li><li><a href="installation/#Installation">Installation</a></li><li><a href="examples/#Examples">Examples</a></li><li><a href="api/#API">API</a></li><li class="no-marker"><ul><li><a href="api/#Load-a-Dataset">Load a Dataset</a></li><li><a href="api/#Types">Types</a></li><li><a href="api/#Lexicons">Lexicons</a></li><li><a href="api/#Index">Index</a></li></ul></li></ul><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>This software is provided under the <a href="https://cecill.info/licences.en.html">CeCILL-C license</a></p><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><ul><li>Lucas Ondel Yang</li><li>Nicolas Denier</li><li>Simon Devauchelle</li></ul><p><img src="https://ptal.lisn.upsaclay.fr/assets/lisn-ups-cnrs.png" alt/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 15:45">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SpeechDatasets</title><meta name="title" content="Home · SpeechDatasets"/><meta property="og:title" content="Home · SpeechDatasets"/><meta property="twitter:title" content="Home · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Contents"><span>Contents</span></a></li><li><a class="tocitem" href="#License"><span>License</span></a></li><li><a class="tocitem" href="#Authors"><span>Authors</span></a></li></ul></li><li><a class="tocitem" href="installation/">Installation</a></li><li><a class="tocitem" href="examples/">Examples</a></li><li><a class="tocitem" href="api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/index.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="SpeechDatasets.jl"><a class="docs-heading-anchor" href="#SpeechDatasets.jl">SpeechDatasets.jl</a><a id="SpeechDatasets.jl-1"></a><a class="docs-heading-anchor-permalink" href="#SpeechDatasets.jl" title="Permalink"></a></h1><p>Convenient and unified way to load a speech dataset. It can then be harnessed with other PTAL tools. </p><p>A <code>SpeechDataset</code> instance consists of a set of recordings (info about audio data) and annotations.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="#SpeechDatasets.jl">SpeechDatasets.jl</a></li><li class="no-marker"><ul><li><a href="#Contents">Contents</a></li><li><a href="#License">License</a></li><li><a href="#Authors">Authors</a></li></ul></li><li><a href="installation/#Installation">Installation</a></li><li><a href="examples/#Examples">Examples</a></li><li><a href="api/#API">API</a></li><li class="no-marker"><ul><li><a href="api/#Load-a-Dataset">Load a Dataset</a></li><li><a href="api/#Types">Types</a></li><li><a href="api/#Lexicons">Lexicons</a></li><li><a href="api/#Index">Index</a></li></ul></li></ul><h2 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h2><p>This software is provided under the <a href="https://cecill.info/licences.en.html">CeCILL-C license</a></p><h2 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h2><ul><li>Lucas Ondel Yang</li><li>Nicolas Denier</li><li>Simon Devauchelle</li></ul><p><img src="https://ptal.lisn.upsaclay.fr/assets/lisn-ups-cnrs.png" alt/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="installation/">Installation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 16:07">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
dev/installation/index.html
+ 1
− 1
View file @ 87e94db9
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Installation · SpeechDatasets</title><meta name="title" content="Installation · SpeechDatasets"/><meta property="og:title" content="Installation · SpeechDatasets"/><meta property="twitter:title" content="Installation · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Installation</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Installation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/installation.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h1><p>This package is part of the PTAL tool collection and requires the <a href="https://gitlab.lisn.upsaclay.fr/ptal/registry">PTAL registry</a> to be installed.</p><p>To add this registry to your Julia installation type <code>]</code> to enter the package mode of the REPL and then type:</p><pre><code class="nohighlight hljs">pkg&gt; registry add &quot;https://gitlab.lisn.upsaclay.fr/PTAL/Registry&quot;</code></pre><p>Once the registry has been added, SpeechDatasets can be installed with the Julia package manager by typing in Pkg REPL mode</p><pre><code class="nohighlight hljs">pkg&gt; add SpeechDatasets</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 15:45">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Installation · SpeechDatasets</title><meta name="title" content="Installation · SpeechDatasets"/><meta property="og:title" content="Installation · SpeechDatasets"/><meta property="twitter:title" content="Installation · SpeechDatasets"/><meta name="description" content="Documentation for SpeechDatasets."/><meta property="og:description" content="Documentation for SpeechDatasets."/><meta property="twitter:description" content="Documentation for SpeechDatasets."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="SpeechDatasets logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">SpeechDatasets</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Installation</a></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../api/">API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Installation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Installation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl" title="View the repository"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://gitlab.lisn.upsaclay.fr/PTAL/Datasets/SpeechDatasets.jl/-/tree/main/docs/src/installation.md" title="Edit source"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h1><p>This package is part of the PTAL tool collection and requires the <a href="https://gitlab.lisn.upsaclay.fr/ptal/registry">PTAL registry</a> to be installed.</p><p>To add this registry to your Julia installation type <code>]</code> to enter the package mode of the REPL and then type:</p><pre><code class="nohighlight hljs">pkg&gt; registry add &quot;https://gitlab.lisn.upsaclay.fr/PTAL/Registry&quot;</code></pre><p>Once the registry has been added, SpeechDatasets can be installed with the Julia package manager by typing in Pkg REPL mode</p><pre><code class="nohighlight hljs">pkg&gt; add SpeechDatasets</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 16:07">Monday 21 October 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
dev/objects.inv
+ 1
− 1
View file @ 87e94db9
# Sphinx inventory version 2 # Sphinx inventory version 2
# Project: SpeechDatasets # Project: SpeechDatasets
# Version: 0.17.2 # Version: 0.18.0
# The remainder of this file is compressed using zlib. # The remainder of this file is compressed using zlib.
xT]k0}l} {骲yduFڤ/H5cPh{瞛vh9},BqaT=k+ v8Ic:Ie!ӷ)@c9K3r`F>n&.1%+!3Q A9r3f[n+.\kFAF@Ќ@9"*Ty~ʆ msM:O@iKd6ލUA&%mDo2&% }PQ%W v߳/5=_=* V szdSI|Nc .د'"2H|'q>PmEeۇک;A!@/Ũe<{erH鶨.%]q֦Hot_(W܁_H-C, xT]k0}l} {骲yduFڤ/H5cPh{瞛vh9},BqaT=k+ v8Ic:Ie!ӷ)@c9K3r`F>n&.1%+!3Q A9r3f[n+.\kFAF@Ќ@9"*Ty~ʆ msM:O@iKd6ލUA&%mDo2&% }PQ%W v߳/5=_=* V szdSI|Nc .د'"2H|'q>PmEeۇک;A!@/Ũe<{erH鶨.%]q֦Hot_(W܁_H-C,
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment