update docs

SuperKogito · May 30, 2024 · e3f4468 · e3f4468
1 parent 8d994b2
commit e3f4468
Show file tree

Hide file tree

Showing 135 changed files with 22,857 additions and 16,902 deletions.
diff --git a/_config.yml b/_config.yml
diff --git a/_images/logo.png b/_images/logo.png
diff --git a/_sources/api/fastft.rst.txt b/_sources/api/fastft.rst.txt
@@ -1,5 +1,5 @@
 ==========
-Fastft api
+fastft api
 ==========
 
 .. include:: class_view_hierarchy.rst.include

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -3,11 +3,33 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Fastft's documentation!
+Welcome to fastft's documentation!
 ==================================
 
+.. image:: _static/logo.png
+   :scale: 30 %
+   :align: center
+
+
+Motivation
+==========
+
+The Short Time Fourier Transform (STFT) is a common tool in audio AI tasks. 
+However, there is currently no standard implementation in C that facilitates fast and efficient features extraction for the purpose of inference. 
+Fastft aims to address this gap by offering an implementation based on the Fastest Fourier Transform in the West (FFTW). 
+This implementation is suitable for Spectrogram/STFT-based inference (e.g., models like Spleeter, MOSnet, 
+etc.), and it can also be extended to cover feature extraction algorithms such as MFCC. 
+The implementation aims to be as efficient as possible in order to target CPU-based low-latency inference solutions.
+
+While some deep learning libraries offer the option of incorporating STFT into the model, these implementations 
+often differ and may restrict developer flexibility; two critical considerations when targeting embedded hardware.
+
+
+Documentation
+============
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 6
    :caption: Contents   
 
    api/fastft.rst

diff --git a/_static/architectures/bark_spectrogram.png b/_static/architectures/bark_spectrogram.png
diff --git a/_static/architectures/bfccs.png b/_static/architectures/bfccs.png
diff --git a/_static/architectures/cqccs.png b/_static/architectures/cqccs.png
diff --git a/_static/architectures/cqt_spectrogram.png b/_static/architectures/cqt_spectrogram.png
diff --git a/_static/architectures/erb_spectrogram.png b/_static/architectures/erb_spectrogram.png
diff --git a/_static/architectures/gammatone_spectrogram.png b/_static/architectures/gammatone_spectrogram.png
diff --git a/_static/architectures/gfccs.png b/_static/architectures/gfccs.png
diff --git a/_static/architectures/imfccs.png b/_static/architectures/imfccs.png
diff --git a/_static/architectures/lfccs.png b/_static/architectures/lfccs.png
diff --git a/_static/architectures/linear_spectrogram.png b/_static/architectures/linear_spectrogram.png
diff --git a/_static/architectures/lpc.png b/_static/architectures/lpc.png
diff --git a/_static/architectures/lpccs.png b/_static/architectures/lpccs.png
diff --git a/_static/architectures/lpcs.png b/_static/architectures/lpcs.png
diff --git a/_static/architectures/mel_spectrogram.png b/_static/architectures/mel_spectrogram.png
diff --git a/_static/architectures/mfccs.png b/_static/architectures/mfccs.png
diff --git a/_static/architectures/msrccs.png b/_static/architectures/msrccs.png
diff --git a/_static/architectures/ngccs.png b/_static/architectures/ngccs.png
diff --git a/_static/architectures/plps.png b/_static/architectures/plps.png
diff --git a/_static/architectures/pncc_medium_processing.png b/_static/architectures/pncc_medium_processing.png
diff --git a/_static/architectures/pncc_temporal_masking.png b/_static/architectures/pncc_temporal_masking.png
diff --git a/_static/architectures/pnccs.png b/_static/architectures/pnccs.png
diff --git a/_static/architectures/psrccs.png b/_static/architectures/psrccs.png
diff --git a/_static/architectures/rplps.png b/_static/architectures/rplps.png
diff --git a/_static/creativecommons.png b/_static/creativecommons.png
diff --git a/_static/css/custom.css b/_static/css/custom.css
@@ -248,72 +248,3 @@ div.timeline div.entry.right::after {
 .gsc-reactions {
     margin-top: 1em;
 }
-
-
-/* Consent form */
-
-/*
- * Bootstrap Cookie Alert by Wruczek
- * https://github.com/Wruczek/Bootstrap-Cookie-Alert
- * Released under MIT license
- */
-.cookiealert {
-    position: fixed;
-    bottom: 0;
-    left: 0;
-    width: 100%;
-		height:100%;
-    margin: 0 !important;
-    z-index: 999;
-    opacity: 0;
-    visibility: hidden;
-    border-radius: 0;
-    transform: translateY(100%);
-    transition: all 250ms ease-out;
-		color: red;
-		background: hsl(0, 0%, 10%, 0.25);
-		padding: 5px 5px;
-		font-size: 16px;
-		border-radius:5px;
-}
-
-.cookiesContainer {
-    width: 50%;
-    height: 10%;
-    display: block;
-    background: var(--main-background-color);
-    margin: 25%;
-    border-radius: 5px;
-		padding: 50px;
-}
-
-.cookiealert.show {
-    opacity: 1;
-    visibility: visible;
-    transform: translateY(0%);
-    transition-delay: 1000ms;
-}
-
-.cookiealert a {
-    text-decoration: underline
-}
-
-.cookiealert .acceptcookies {
-    margin-left: 1px;
-    vertical-align: baseline;
-		margin-bottom:0.5em;
-}
-
-
-/* footer */
-.footer-links li
-{
-  display:block
-}
-.footer-links.inline li
-{
-  display:inline-block
-}
-
-/* image */
-image-rendering: pixelated;
diff --git a/_static/css/social_media_sharing.css b/_static/css/social_media_sharing.css
diff --git a/_static/css/tree_graph.css b/_static/css/tree_graph.css
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -7,7 +7,7 @@ const DOCUMENTATION_OPTIONS = {
     LINK_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false,
+    NAVIGATION_WITH_KEYS: true,
     SHOW_SEARCH_SUMMARY: true,
     ENABLE_SEARCH_SHORTCUTS: true,
 };
diff --git a/_static/favicon.ico b/_static/favicon.ico
diff --git a/_static/favicon_io/android-chrome-192x192.png b/_static/favicon_io/android-chrome-192x192.png
diff --git a/_static/favicon_io/android-chrome-512x512.png b/_static/favicon_io/android-chrome-512x512.png
diff --git a/_static/favicon_io/apple-touch-icon.png b/_static/favicon_io/apple-touch-icon.png
diff --git a/_static/favicon_io/favicon-16x16.png b/_static/favicon_io/favicon-16x16.png
diff --git a/_static/favicon_io/favicon-32x32.png b/_static/favicon_io/favicon-32x32.png
diff --git a/_static/favicon_io/favicon.ico b/_static/favicon_io/favicon.ico
diff --git a/_static/favicon_io/site.webmanifest b/_static/favicon_io/site.webmanifest
@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}