docs.html

<!DOCTYPE html>
<html lang="fr">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>ORATIS</title>
    <meta name="description" content="ORATIS - Un groupe de développement créatif, innovant, offrant des solutions technologiques avancées, dont des projets comme Oratis AI, Keyscapes, et BitsDefender.">
    <meta property="og:title" content="ORATIS - Groupe de Développement">
    <meta property="og:description" content="Explorez les projets du groupe de développement ORATIS : Oratis AI, Keyscapes, et BitsDefender. Technologie, innovation et créativité au service des utilisateurs.">
    <meta property="og:type" content="website">
    <meta property="og:url" content="https://www.oratis.fr">
    <meta property="og:image" content="https://www.oratis.fr/assets/oratis.png">
    <link rel="icon" type="image/png" href="assets/oratis.png" />
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;700&display=swap" rel="stylesheet">
    <style>
        * {
            margin: 0;
            padding: 0;
            box-sizing: border-box;
        }

        body {
            font-family: 'Roboto', sans-serif;
            line-height: 1.6;
            color: #f4f4f9;
            background-color: #121212;
            padding: 2rem;
        }

        ::-webkit-scrollbar {
            width: 12px;
        }

        ::-webkit-scrollbar-track {
            background: #1e1e1e;
        }

        ::-webkit-scrollbar-thumb {
            background: #4CAF50;
            border-radius: 6px;
        }

        ::-webkit-scrollbar-thumb:hover {
            background: #81C784;
        }

        header {
            text-align: center;
            margin-bottom: 2rem;
        }

        header h1 {
            font-size: 2.5rem;
            color: #4CAF50;
        }

        nav {
            margin-top: 1rem;
        }

        nav a {
            margin: 0 1rem;
            text-decoration: none;
            color: #4CAF50;
            font-weight: bold;
            transition: color 0.3s;
        }

        nav a:hover {
            color: #81C784;
        }

        section {
            margin-bottom: 3rem;
            padding: 2rem;
            background: #1e1e1e;
            border-radius: 10px;
            box-shadow: 0 4px 8px rgba(0, 0, 0, 0.5);
        }

        section h2 {
            font-size: 2rem;
            margin-bottom: 1rem;
            color: #4CAF50;
        }

        section p {
            margin-bottom: 1rem;
            color: #e0e0e0;
        }

        section code {
            display: block;
            background: #2e2e2e;
            border: 1px solid #444;
            padding: 1rem;
            border-radius: 5px;
            margin-bottom: 1rem;
            white-space: pre-wrap;
            color: #81C784;
        }

        footer {
            text-align: center;
            margin-top: 3rem;
            color: #e0e0e0;
        }

        footer a {
            color: #4CAF50;
            text-decoration: none;
        }

        .warning {
            color: #FF9800;
            font-weight: bold;
            margin-top: 1rem;
        }
    </style>
</head>
<body>
    <header>
        <h1>Documentation</h1>
        <nav>
            <a href="#installation">Installation</a>
            <a href="#utilisation">Utilisation</a>
            <a href="#modules">Modules</a>
            <a href="#details">Détails Techniques</a>
            <a href="#contact">Contact</a>
        </nav>
    </header>

    <main>
        <section id="installation">
            <h2>Installation</h2>
            <p>Pour installer ORATIS, suivez les étapes ci-dessous :</p>
            <ol>
                <li>Clonez le dépôt ou téléchargez-le directement :</li>
                <code>git clone <URL_DU_DEPOT></code>
                <li>Accédez au répertoire :</li>
                <code>cd ORATIS</code>
                <li>Installez les dépendances :</li>
                <code>pip install -r requirements.txt</code>
                <li>Assurez-vous que Python 3.8 ou une version ultérieure est installé.</li>
            </ol>
        </section>

        <section id="utilisation">
            <h2>Utilisation</h2>
            <p>Voici comment utiliser le pipeline ORATIS :</p>
            <p><strong>Important :</strong> Le modèle est fourni sans données préalablement entraînées. Vous devez lui apprendre à partir de vos propres fichiers audio et transcriptions.</p>
            <ol>
                <li>Placez vos fichiers audio (formats supportés : .wav ou .mp3) dans le dossier : <code>data/raw</code></li>
                <li>Créez des fichiers de retranscriptions correspondants avec exactement le même nom que les fichiers audio dans : <code>data/transcripts</code> </li>
                <li>Lancez le pipeline pour préparer et entraîner le modèle :</li>
                <code>python main.py</code>
                <p class="warning">Attention : Assurez-vous que chaque fichier audio a une retranscription correspondante pour éviter des erreurs.</p>
                <h3>Options disponibles :</h3>
                <ul>
                    <li>Segmente les fichiers audio en portions de 30 secondes. <code>--segment yes</code></li>
                    <p class="warning">Attention : L'option peut rencontrer des problèmes ou produire des résultats inattendus. Utilisez avec précaution.</p>
                    <li>Utilise les fichiers audio dans leur intégralité. <code>--segment no</code></li>
                </ul>
            </ol>
        </section>

        <section id="modules">
            <h2>Modules</h2>

            <h3>Prétraitement</h3>
            <p>Le module de prétraitement nettoie et normalise les fichiers audio :</p>
            <ul>
                <li>Convertit les fichiers en mono.</li>
                <li>Rééchantillonne à 16kHz.</li>
                <li>Optionnel : Segmente les fichiers en morceaux de 30 secondes.</li>
            </ul>
            <code>python scripts/preprocess.py --segment yes</code>

            <h3>Extraction des caractéristiques</h3>
            <p>Ce module extrait des MFCCs (Mel Frequency Cepstral Coefficients) pour représenter les données audio :</p>
            <ul>
                <li>Utilise la bibliothèque <code>librosa</code></li>
                <li>Extrait 13 coefficients par fenêtre temporelle.</li>
            </ul>
            <code>python scripts/extract_features.py</code>

            <h3>Entraînement du modèle</h3>
            <p>Ce module entraîne un modèle LSTM :</p>
            <ul>
                <li>Prend en entrée les MFCCs extraits.</li>
                <li>Utilise une loss CTC (Connectionist Temporal Classification).</li>
                <li>Enregistre le modèle dans le dossier. <code>models</code></li>
            </ul>
            <code>python scripts/train_model.py</code>

            <h3>Décodage</h3>
            <p>Ce module utilise le modèle entraîné pour transcrire des fichiers audio :</p>
            <ul>
                <li>Charge les MFCCs des fichiers audio.</li>
                <li>Applique le modèle pour produire une séquence de caractères.</li>
            </ul>
            <code>python scripts/decode_audio.py</code>

            <h3>Évaluation</h3>
            <p>Ce module évalue les transcriptions avec des métriques :</p>
            <ul>
                <li><strong>WER</strong> (Word Error Rate).</li>
                <li><strong>CER</strong> (Character Error Rate).</li>
            </ul>
            <code>python scripts/evaluate.py</code>
        </section>

        <section id="details">
            <h2>Détails Techniques</h2>

            <h3>Pipeline Principal</h3>
            <p>Le script principal <code>main.py</code> exécute le pipeline complet :</p>
            <code>from scripts import preprocess, extract_features, train_model, decode_audio, evaluate

preprocess(config, segment_audio=True)
extract_features(config)
train_model(config)
decode_audio(config)
evaluate(config)</code>
            <p>Chaque étape est modulable et peut être utilisée indépendamment.</p>

            <h3>Configuration</h3>
            <p>Les chemins et paramètres sont définis dans : <code>config.yaml</code></p>
            <code>paths:
  raw_audio: "data/raw"
  processed_audio: "data/processed"
  transcripts: "data/transcripts"
  features: "features"
  models: "models/trained_model.pth"
  decoded_texts: "results/decoded_texts"

training:
  batch_size: 32
  epochs: 20
  learning_rate: 0.001
  input_dim: 13
  hidden_dim: 128
  output_dim: 29</code>
        </section>

        <section id="contact">
            <h2>Contact</h2>
            <p>Pour toute question ou assistance, contactez-nous via notre <a href="https://github.com/KucoDEV/Oratis">dépôt GitHub</a></p>
        </section>
    </main>

    <footer>
        <p>© 2024 <a href="https://www.oratis.fr">ORATIS</a> - Tous droits réservés.</p>
    </footer>
</body>
</html>