IFT 3710/6759 - Instructions pour les présentations et le rapport final

Les présentations orales, les rapports finaux et le code des projets sont les principaux livrables de ce cours. La note finale est entièrement basée sur le travail sur le projet et la présentation, le rapport et le code source constituent votre principal moyen d’expliquer et de montrer votre travail.

Dates

Les présentations auront lieu en classe le 4 avril, à l’heure habituelle de la session et de la salle : jeudi 4 avril, 10h30–12h30 (EST), salle à préciser.

Les rapports finaux et le code source doivent être remis le 26 avril 2024 à 23:59 (EST).

Présentations

Chaque équipe doit faire une présentation en classe à la date mentionnée ci-dessus. Les présentations doivent être en français et durer environ 10 minutes, sans compter les questions. La participation et l’engagement dans les sessions de présentation compteront pour la partie de la note correspondant aux présentations.

L’objectif principal des présentations est d’expliquer le travail que vous avez réalisé dans le cadre de votre projet et de transmettre les résultats et les conclusions les plus importants. Une bonne présentation sera celle qui permettra au reste de la classe d’apprendre quelque chose de nouveau. Par conséquent, c’est une bonne idée de fournir un contexte suffisant et de préparer une présentation efficace. Vous trouverez ci-dessous quelques ressources utiles pour préparer et donner des présentations efficaces :

Rapports finaux

Le rapport final de votre projet est le principal résultat de ce cours, car c’est le document où vous pouvez le mieux démontrer le travail que vous avez effectué tout au long du trimestre. Les rapports finaux doivent inclure le contenu suivant :

  • Titre
  • Membres de l’équipe
  • Résumé
  • Introduction : contexte, motivation et résumé du travail.
  • Revue de la littérature
  • Méthodes
  • Résultats
  • Conclusions
  • Contributions de chaque membre de l’équipe
  • Références

Bien que cette structure soit recommandée, n’hésitez pas à la modifier si vous avez une bonne raison de le faire. Bien que le rapport puisse ressembler à une publication scientifique, une différence importante doit être observée : Vous êtes encouragé à inclure les méthodes et les résultats qui n’ont pas fonctionné comme vous l’aviez prévu, s’ils ont constitué une partie importante de votre travail et/ou si vous pensez qu’on peut en tirer des enseignements.

Les différentes parties correspondent étroitement aux devoirs sur lesquels vous avez travaillé pendant le cours. Si vous avez produit des versions quasi finales des parties pour les devoirs intermédiaires, vous pouvez les réutiliser pour le rapport final.

Format et modèle

La longueur recommandée pour les rapports finaux est d’environ 8 pages, avec un minimum de 6 et un maximum de 10 pages, sans compter la liste des références. Vous pouvez inclure du matériel supplémentaire si vous le jugez important, mais prenez en compte que l’évaluation sera principalement basée sur le corps principal du rapport. Les instructions de formatage pour le rapport sont les suivantes :

  • Taille du texte :
    • Paragraphes principaux : 10 points
    • Titres de premier niveau : 12 points, caractères gras
    • Titres de niveau inférieur : 10 points, caractères gras
  • Espacement vertical : 11 points
  • Séparation des paragraphes : 5,5 points, pas d’indentation
  • Marges :
    • Marge gauche : 9 picas
    • Largeur du texte : 33 picas
    • Hauteur du texte : 54 picas

Les instructions ci-dessus sont héritées des directives pour les soumissions de NeurIPS 2023. Si vous avez de l’expérience avec LaTeX ou si vous êtes prêt à apprendre, vous êtes fortement encouragé à utiliser le modèle LaTeX de NeurIPS 2022 ou le modèle latex-simple (plus simple et crée par l’instructeur), car ils vous permettront de vous concentrer sur le contenu plutôt que sur le format tout en produisant un document bien formaté. Si vous n’avez pas beaucoup d’expérience avec LaTeX, vous trouverez peut-être Overleaf utile.

Conseils pour la rédaction scientifique

La note finale tiendra compte non seulement du travail effectué au cours du développement du projet tel qu’il est reflété par le rapport, mais aussi de la qualité du rapport lui-même. Par conséquent, assurez-vous de suivre les directives courantes pour rédiger de bons articles scientifiques ou rapports techniques. Les bons articles suivent généralement une structure narrative complète :

  1. Contexte : nécessaire pour comprendre le besoin (2)
  2. Besoin : quelle est la motivation ultime ? Pourquoi est-ce important ?
  3. Tâche : objectif global
  4. Objet : objectif particulier du présent document
  5. Constatations
  6. Conclusions
  7. Perspective : travail futur

Cette structure suit une entonnoir inversé, c’est-à-dire qu’il commence par le contexte général, progresse vers les détails et se termine à nouveau par une perspective générale. En y regardant de plus près, les points 1 à 4 concernent le “pourquoi” et les points 5 à 7 le “quoi”. Plus le public cible est spécialisé, plus l’accent est mis sur le quoi et moins sur le pourquoi ; plus il est général, c’est l’inverse. Cette structure est utile non seulement pour organiser un article, mais aussi le résumé.

Une autre règle plus compacte et plus efficace pour organiser des éléments d’information (histoires) est le schéma contexte-contenu-conclusion (CCC). Le raisonnement pour cette structure est que chaque élément de contenu est transmis plus efficacement s’il est introduit par un contexte et conclu par une conclusion. Cela s’applique à un rapport dans son ensemble, mais aussi à une section et à un paragraphe. C’est également un bon schéma à suivre pour préparer des diapositives.

Un bon article facile à lire sur la rédaction scientifique est le suivant :

Code source

Le code source de votre projet fait également partie de l’évaluation. Veuillez fournir un lien vers un dépôt GitHub (ou GitLab, ou similaire) avec votre code source à côté de votre rapport final. Un bon code doit être facile à lire et à exécuter. Par conséquent, veillez à nettoyer la version finale de votre code : supprimez les morceaux de code anciens ou inutiles, ajoutez de la documentation, rédigez un README avec des instructions sur la façon d’exécuter le code et des exemples pour reproduire vos expériences, etc. En particulier, pensez à indiquer explicitement les éléments suivants :

  • La version de Python que vous avez utilisée pour exécuter vos expériences.
  • Les bibliothèques nécessaires et leurs versions. Si vous avez utilisé des environnements virtuels, comme cela a été recommandé, un moyen simple d’indiquer les bibliothèques nécessaires est d’utiliser un fichier requirements.txt. Vous pouvez en générer un en exécutant dans un shell avec votre environnement activé la commande suivante : python -m pip freeze > requirements.txt. Avec un fichier requirements.txt disponible, il devrait être facile de reproduire l’environnement en exécutant python -m pip install -r requirements.txt.

Une bonne pratique pour s’assurer que vous avez inclus toutes les informations nécessaires pour exécuter votre code est de suivre vos propres instructions dans un nouvel environnement frais et de vérifier que le code s’exécute sans problème.

Étant donné que vos expériences peuvent être coûteuses en termes de calcul, veuillez envisager de préparer une configuration légère afin d’exécuter votre code à sec, par exemple avec un sous-ensemble de données, une architecture plus simple, quelques époques, etc.