Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • fast/speechdatasets.jl
  • PTAL/Datasets/SpeechDatasets.jl
2 results
Show changes
Commits on Source (8)
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 193 additions and 0 deletions
dev/.documenter-siteinfo.json 0 → 100644
View file @ 87e94db9
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-10-21T16:07:09","documenter_version":"1.7.0"}}
\ No newline at end of file
dev/api/index.html 0 → 100644
View file @ 87e94db9
This diff is collapsed.
dev/assets/documenter.js 0 → 100644
View file @ 87e94db9
This diff is collapsed.
dev/assets/logo.svg 0 → 100644
View file @ 87e94db9
<svg version="1.1" width="200" height="200" xmlns="http://www.w3.org/2000/svg">
<mask id="myMask">
<rect x="0" y="0" width="200" height="200" fill="white" />
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="black" transform="rotate(45,100,100)"/>
</mask>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(0.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(45.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(90.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(135.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(180.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(225.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(270.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(315.0, 100, 100)" mask="url(#myMask)"/>
<circle cx="100" cy="100" r="27.878" stroke="black" stroke-width="2.41" fill="yellow"/>
</svg>
dev/assets/ptal-logo.svg 0 → 100644
View file @ 87e94db9
<svg version="1.1" width="200" height="200" xmlns="http://www.w3.org/2000/svg">
<mask id="myMask">
<rect x="0" y="0" width="200" height="200" fill="white" />
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="black" transform="rotate(45,100,100)"/>
</mask>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(0.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(45.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(90.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(135.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(180.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(225.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(270.0, 100, 100)"/>
<ellipse cx="52.5" cy="100" rx="42.5" ry="25" stroke="black" stroke-width="2.41" fill="white" transform="rotate(315.0, 100, 100)" mask="url(#myMask)"/>
<circle cx="100" cy="100" r="27.878" stroke="black" stroke-width="2.41" fill="yellow"/>
</svg>
dev/assets/themes/catppuccin-frappe.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themes/catppuccin-latte.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themes/catppuccin-macchiato.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themes/catppuccin-mocha.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themes/documenter-dark.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themes/documenter-light.css 0 → 100644
View file @ 87e94db9
Source diff could not be displayed: it is too large. Options to address this: view the blob.
dev/assets/themeswap.js 0 → 100644
View file @ 87e94db9
// Small function to quickly swap out themes. Gets put into the <head> tag..
function set_theme_from_local_storage() {
// Initialize the theme to null, which means default
var theme = null;
// If the browser supports the localstorage and is not disabled then try to get the
// documenter theme
if (window.localStorage != null) {
// Get the user-picked theme from localStorage. May be `null`, which means the default
// theme.
theme = window.localStorage.getItem("documenter-theme");
}
// Check if the users preference is for dark color scheme
var darkPreference =
window.matchMedia("(prefers-color-scheme: dark)").matches === true;
// Initialize a few variables for the loop:
//
// - active: will contain the index of the theme that should be active. Note that there
// is no guarantee that localStorage contains sane values. If `active` stays `null`
// we either could not find the theme or it is the default (primary) theme anyway.
// Either way, we then need to stick to the primary theme.
//
// - disabled: style sheets that should be disabled (i.e. all the theme style sheets
// that are not the currently active theme)
var active = null;
var disabled = [];
var primaryLightTheme = null;
var primaryDarkTheme = null;
for (var i = 0; i < document.styleSheets.length; i++) {
var ss = document.styleSheets[i];
// The <link> tag of each style sheet is expected to have a data-theme-name attribute
// which must contain the name of the theme. The names in localStorage much match this.
var themename = ss.ownerNode.getAttribute("data-theme-name");
// attribute not set => non-theme stylesheet => ignore
if (themename === null) continue;
// To distinguish the default (primary) theme, it needs to have the data-theme-primary
// attribute set.
if (ss.ownerNode.getAttribute("data-theme-primary") !== null) {
primaryLightTheme = themename;
}
// Check if the theme is primary dark theme so that we could store its name in darkTheme
if (ss.ownerNode.getAttribute("data-theme-primary-dark") !== null) {
primaryDarkTheme = themename;
}
// If we find a matching theme (and it's not the default), we'll set active to non-null
if (themename === theme) active = i;
// Store the style sheets of inactive themes so that we could disable them
if (themename !== theme) disabled.push(ss);
}
var activeTheme = null;
if (active !== null) {
// If we did find an active theme, we'll (1) add the theme--$(theme) class to <html>
document.getElementsByTagName("html")[0].className = "theme--" + theme;
activeTheme = theme;
} else {
// If we did _not_ find an active theme, then we need to fall back to the primary theme
// which can either be dark or light, depending on the user's OS preference.
var activeTheme = darkPreference ? primaryDarkTheme : primaryLightTheme;
// In case it somehow happens that the relevant primary theme was not found in the
// preceding loop, we abort without doing anything.
if (activeTheme === null) {
console.error("Unable to determine primary theme.");
return;
}
// When switching to the primary light theme, then we must not have a class name
// for the <html> tag. That's only for non-primary or the primary dark theme.
if (darkPreference) {
document.getElementsByTagName("html")[0].className =
"theme--" + activeTheme;
} else {
document.getElementsByTagName("html")[0].className = "";
}
}
for (var i = 0; i < document.styleSheets.length; i++) {
var ss = document.styleSheets[i];
// The <link> tag of each style sheet is expected to have a data-theme-name attribute
// which must contain the name of the theme. The names in localStorage much match this.
var themename = ss.ownerNode.getAttribute("data-theme-name");
// attribute not set => non-theme stylesheet => ignore
if (themename === null) continue;
// we'll disable all the stylesheets, except for the active one
ss.disabled = !(themename == activeTheme);
}
}
set_theme_from_local_storage();
dev/assets/warner.js 0 → 100644
View file @ 87e94db9
function maybeAddWarning() {
// DOCUMENTER_NEWEST is defined in versions.js, DOCUMENTER_CURRENT_VERSION and DOCUMENTER_STABLE
// in siteinfo.js.
// If either of these are undefined something went horribly wrong, so we abort.
if (
window.DOCUMENTER_NEWEST === undefined ||
window.DOCUMENTER_CURRENT_VERSION === undefined ||
window.DOCUMENTER_STABLE === undefined
) {
return;
}
// Current version is not a version number, so we can't tell if it's the newest version. Abort.
if (!/v(\d+\.)*\d+/.test(window.DOCUMENTER_CURRENT_VERSION)) {
return;
}
// Current version is newest version, so no need to add a warning.
if (window.DOCUMENTER_NEWEST === window.DOCUMENTER_CURRENT_VERSION) {
return;
}
// Add a noindex meta tag (unless one exists) so that search engines don't index this version of the docs.
if (document.body.querySelector('meta[name="robots"]') === null) {
const meta = document.createElement("meta");
meta.name = "robots";
meta.content = "noindex";
document.getElementsByTagName("head")[0].appendChild(meta);
}
const div = document.createElement("div");
div.classList.add("outdated-warning-overlay");
const closer = document.createElement("button");
closer.classList.add("outdated-warning-closer", "delete");
closer.addEventListener("click", function () {
document.body.removeChild(div);
});
const href = window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
div.innerHTML =
'This documentation is not for the latest stable release, but for either the development version or an older release.<br><a href="' +
href +
'">Click here to go to the documentation for the latest stable release.</a>';
div.appendChild(closer);
document.body.appendChild(div);
}
if (document.readyState === "loading") {
document.addEventListener("DOMContentLoaded", maybeAddWarning);
} else {
maybeAddWarning();
}
dev/examples/index.html 0 → 100644
View file @ 87e94db9
<!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
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 0 → 100644
View file @ 87e94db9
<!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 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 0 → 100644
View file @ 87e94db9
<!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 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 0 → 100644
View file @ 87e94db9
# Sphinx inventory version 2
# Project: SpeechDatasets
# Version: 0.18.0
# 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,
\ No newline at end of file
dev/search_index.js 0 → 100644
View file @ 87e94db9
var documenterSearchIndex = {"docs":
[{"location":"api/#API","page":"API","title":"API","text":"","category":"section"},{"location":"api/#Load-a-Dataset","page":"API","title":"Load a Dataset","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"To get data from a supported dataset, you only need one function:","category":"page"},{"location":"api/","page":"API","title":"API","text":"dataset\n","category":"page"},{"location":"api/#SpeechDatasets.dataset","page":"API","title":"SpeechDatasets.dataset","text":"dataset(dataset, inputdir::AbstractString, outputdir::AbstractString; kwargs...)\n\nCreate a SpeechDataset object for dataset. inputdir is the directory containing the raw data. If the inputdir does not exist and the data is freely available, it will be automatically downloaded and put in inputdir. outputdir is the directory where will be stored summary files. kwargs... are dataset specific arguments passed to dataset\n\n\n\n\n\n","category":"function"},{"location":"api/#Types","page":"API","title":"Types","text":"","category":"section"},{"location":"api/#SpeechDataset","page":"API","title":"SpeechDataset","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"SpeechDataset","category":"page"},{"location":"api/#SpeechDatasets.SpeechDataset","page":"API","title":"SpeechDatasets.SpeechDataset","text":"SpeechDataset\n\nStore metadata about a speech dataset.\n\n\n\n\n\n","category":"type"},{"location":"api/","page":"API","title":"API","text":"Access a single element with integer or id indexing","category":"page"},{"location":"api/","page":"API","title":"API","text":"# ds::SpeechDataset\nds[1]\nds[\"1988-147956-0027\"]","category":"page"},{"location":"api/#Manifest-items","page":"API","title":"Manifest items","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"SpeechDatasets.ManifestItem\nRecording\nAnnotation\nAudioSources.load(r::Recording; start = -1, duration = -1, channels = r.channels)\nAudioSources.load(r::Recording, a::Annotation)\nSpeechDatasets.load_manifest(T::Type{<:Union{Recording, Annotation}}, path)","category":"page"},{"location":"api/#SpeechDatasets.ManifestItem","page":"API","title":"SpeechDatasets.ManifestItem","text":"abstract type ManifestItem end\n\nBase class for all manifest item. Every manifest item should have an id attribute.\n\n\n\n\n\n","category":"type"},{"location":"api/#SpeechDatasets.Recording","page":"API","title":"SpeechDatasets.Recording","text":"struct Recording{Ts<:AbstractAudioSource} <: ManifestItem\n id::AbstractString\n source::Ts\n channels::Vector{Int}\n samplerate::Int\nend\n\nA recording is an audio source associated with and id.\n\nConstructors\n\nRecording(id, source, channels, samplerate)\nRecording(id, source[; channels = missing, samplerate = missing])\n\nIf the channels or the sample rate are not provided then they will be read from source.\n\nwarning: Warning\nWhen preparing large corpus, not providing the channels and/or the sample rate can drastically reduce the speed as it forces to read source.\n\n\n\n\n\n","category":"type"},{"location":"api/#SpeechDatasets.Annotation","page":"API","title":"SpeechDatasets.Annotation","text":"struct Annotation <: ManifestItem\n id::AbstractString\n recording_id::AbstractString\n start::Float64\n duration::Float64\n channel::Union{Vector, Colon}\n data::Dict\nend\n\nAn \"annotation\" defines a segment of a recording on a single channel. The data field is an arbitrary dictionary holdin the nature of the annotation. start and duration (in seconds) defines, where the segment is locatated within the recoding recording_id.\n\nConstructor\n\nAnnotation(id, recording_id, start, duration, channel, data)\nAnnotation(id, recording_id[; channel = missing, start = -1, duration = -1, data = missing)\n\nIf start and/or duration are negative, the segment is considered to be the whole sequence length of the recording.\n\n\n\n\n\n","category":"type"},{"location":"api/#AudioSources.load-Tuple{Recording}","page":"API","title":"AudioSources.load","text":"load(recording::Recording [; start = -1, duration = -1, channels = recording.channels])\nload(recording, annotation)\n\nLoad the signal from a recording. start, duration (in seconds)\n\nThe function returns a tuple (x, sr) where x is a NC array\n\nN is the length of the signal and C is the number of channels\nand sr is the sampling rate of the signal.\n\n\n\n\n\n","category":"method"},{"location":"api/#AudioSources.load-Tuple{Recording, Annotation}","page":"API","title":"AudioSources.load","text":"load(r::Recording, a::Annotation)\nload(t::Tuple{Recording, Annotation})\n\nLoad only a segment of the recording referenced in the annotation.\n\n\n\n\n\n","category":"method"},{"location":"api/#SpeechDatasets.load_manifest-Tuple{Type{<:Union{Annotation, Recording}}, Any}","page":"API","title":"SpeechDatasets.load_manifest","text":"load_manifest(Annotation, path)\nload_manifest(Recording, path)\n\nLoad Recording/Annotation manifest from path.\n\n\n\n\n\n","category":"method"},{"location":"api/#Lexicons","page":"API","title":"Lexicons","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"CMUDICT(path)\nTIMITDICT(timitdir)\nMFAFRDICT(path)","category":"page"},{"location":"api/#SpeechDatasets.CMUDICT-Tuple{Any}","page":"API","title":"SpeechDatasets.CMUDICT","text":"CMUDICT(path)\n\nReturn the dictionary of pronunciation loaded from the CMU sphinx dictionary. The CMU dictionary will be donwloaded and stored into to path. Subsequent calls will only read the file path without downloading again the data.\n\n\n\n\n\n","category":"method"},{"location":"api/#SpeechDatasets.TIMITDICT-Tuple{Any}","page":"API","title":"SpeechDatasets.TIMITDICT","text":"TIMITDICT(timitdir)\n\nReturn the dictionary of pronunciation as provided by TIMIT corpus (located in timitdir).\n\n\n\n\n\n","category":"method"},{"location":"api/#SpeechDatasets.MFAFRDICT-Tuple{Any}","page":"API","title":"SpeechDatasets.MFAFRDICT","text":"MFAFRDICT(path)\n\nReturn the french dictionary of pronunciation as provided by MFA (french_mfa v2.0.0a).\n\n\n\n\n\n","category":"method"},{"location":"api/#Index","page":"API","title":"Index","text":"","category":"section"},{"location":"api/","page":"API","title":"API","text":"","category":"page"},{"location":"examples/#Examples","page":"Examples","title":"Examples","text":"","category":"section"},{"location":"examples/","page":"Examples","title":"Examples","text":"using SpeechDatasets\nds = dataset(:TIMIT, \"path/to/timit\", \"outputdir/timit\")","category":"page"},{"location":"installation/#Installation","page":"Installation","title":"Installation","text":"","category":"section"},{"location":"installation/","page":"Installation","title":"Installation","text":"This package is part of the PTAL tool collection and requires the PTAL registry to be installed.","category":"page"},{"location":"installation/","page":"Installation","title":"Installation","text":"To add this registry to your Julia installation type ] to enter the package mode of the REPL and then type:","category":"page"},{"location":"installation/","page":"Installation","title":"Installation","text":"pkg> registry add \"https://gitlab.lisn.upsaclay.fr/PTAL/Registry\"","category":"page"},{"location":"installation/","page":"Installation","title":"Installation","text":"Once the registry has been added, SpeechDatasets can be installed with the Julia package manager by typing in Pkg REPL mode","category":"page"},{"location":"installation/","page":"Installation","title":"Installation","text":"pkg> add SpeechDatasets","category":"page"},{"location":"#SpeechDatasets.jl","page":"Home","title":"SpeechDatasets.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Convenient and unified way to load a speech dataset. It can then be harnessed with other PTAL tools. ","category":"page"},{"location":"","page":"Home","title":"Home","text":"A SpeechDataset instance consists of a set of recordings (info about audio data) and annotations.","category":"page"},{"location":"#Contents","page":"Home","title":"Contents","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Pages = [\"index.md\", \"installation.md\", \"examples.md\", \"api.md\", \"datasets.md\", \"newdataset.md\"]","category":"page"},{"location":"#License","page":"Home","title":"License","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"This software is provided under the CeCILL-C license","category":"page"},{"location":"#Authors","page":"Home","title":"Authors","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Lucas Ondel Yang\nNicolas Denier\nSimon Devauchelle","category":"page"},{"location":"","page":"Home","title":"Home","text":"(Image: )","category":"page"}]
}
dev/siteinfo.js 0 → 100644
View file @ 87e94db9
var DOCUMENTER_CURRENT_VERSION = "dev";
index.html 0 → 100644
View file @ 87e94db9
<!--This file is automatically generated by Documenter.jl-->
<meta http-equiv="refresh" content="0; url=./dev/"/>