Documentation

Tout ce qu'il faut savoir pour lire et publier sur Komor-IA Research.

1. Lire les publications

La lecture est libre, sans compte. Chaque publication commence par un encadré « En bref » qui résume, sans jargon, ce qui a été fait et pourquoi c'est utile. Son niveau (débutant, intermédiaire ou avancé) est indiqué en haut.

  • Dans les blocs de code, les lignes surlignées portent une explication : à droite sur ordinateur, ou en touchant la pastille numérotée sur mobile. L'interrupteur « Afficher les explications » les masque si vous préférez lire le code seul.
  • Le bouton « Ouvrir dans Colab », quand il existe, ouvre le notebook de l'auteur pour exécuter le code vous-même.
  • La page Explorer permet de chercher par mots, par tag, par niveau et par langue.

2. Devenir auteur

  1. Créez un compte. Un administrateur le valide ; vous recevez alors un email.
  2. Depuis votre studio, déposez une candidature d'auteur. Il faut au moins une preuve de votre parcours : lier votre ORCID, faire vérifier une adresse email institutionnelle (université, laboratoire, entreprise) par un code, ou indiquer votre profil Google Scholar ou HAL.
  3. Présentez vos travaux et ce que vous souhaitez publier. La réponse arrive par email ; en cas de refus, le motif est indiqué et vous pouvez compléter votre dossier.

3. Organiser ses espaces

Un espace regroupe vos publications sur un même thème, par exemple « NLP » ou « Traduction automatique ». Vous pouvez en créer jusqu'à 20. Son adresse publique (/a/votre-nom/nom-de-l-espace) peut changer tant qu'il ne contient aucune publication, puis elle est figée pour ne pas casser les liens partagés. Un espace n'apparaît sur votre profil public qu'à partir de sa première publication en ligne.

4. Écrire une publication

Une publication est une suite de blocs, que vous ajoutez avec « Ajouter un bloc » et réordonnez avec les flèches :

  • Texte, en Markdown, avec un onglet « Aperçu ».
  • Code : choisissez le langage ; la coloration est appliquée à la lecture. La touche Tab insère une indentation (Échap puis Tab pour quitter le champ).
  • Formule : du LaTeX, affiché en grand avec un aperçu immédiat.
  • Image : PNG, JPEG, WebP ou GIF, 4 Mo au maximum. Le texte alternatif est obligatoire : il décrit l'image aux personnes aveugles ou malvoyantes.

Quelques repères de Markdown :

Vous écrivezVous obtenez
## Titreun intertitre
**gras** et *italique*du texte en gras et en italique
[texte](https://…)un lien
- élémentune liste à puces
`tokenizer`du code dans le texte
$E = mc^2$une formule dans la phrase
| a | b |un tableau (avec une ligne |---|---| sous l'en-tête)

Votre travail est enregistré automatiquement toutes les 30 secondes, et à tout moment avec le bouton « Enregistrer » ou Ctrl+S. Si vous ouvrez la même publication dans deux onglets, l'enregistrement du second est refusé plutôt que d'écraser le premier : rechargez simplement la page. Le bouton « Aperçu » montre la publication telle que les lecteurs la verront.

5. Expliquer son code ligne par ligne

C'est ce qui rend une publication vraiment utile aux lecteurs qui débutent. Dans un bloc de code, ouvrez l'onglet « Explications », cliquez sur un numéro de ligne (Maj+clic pour sélectionner plusieurs lignes), puis « Ajouter une note ». Les notes acceptent du Markdown court (1000 caractères au maximum, 50 notes par bloc) ; deux notes ne peuvent pas porter sur les mêmes lignes.

Si vous raccourcissez ensuite le code, une note qui vise des lignes disparues est marquée « à revoir » : sélectionnez les bonnes lignes et choisissez « Déplacer sur la sélection », ou supprimez-la. La publication ne peut pas être publiée tant qu'une note est à revoir.

6. Importer un notebook

En bas de l'éditeur, « Importer un notebook (.ipynb) » ajoute les cellules d'un notebook Jupyter ou Colab à la fin de votre publication (10 Mo au maximum). Rien n'est exécuté : nous lisons seulement le fichier et les résultats déjà présents.

  • Les cellules Markdown deviennent des blocs de texte ; le premier titre devient celui de la publication s'il n'en a pas encore.
  • Les cellules de code gardent leur numéro d'exécution et leurs sorties : texte, erreurs, graphiques (jusqu'à 30 images) et tableaux pandas.
  • Les widgets, le JavaScript et le HTML autre que les tableaux sont ignorés, pour la sécurité des lecteurs ; un bilan vous l'indique après l'import.

Vous pouvez ensuite modifier et annoter le code de chaque cellule, ou retirer ses sorties.

7. Publier

Le bouton « Publier » s'active quand la publication a :

  • un titre d'au moins 5 caractères ;
  • un résumé « En bref » d'au moins 100 caractères ;
  • un niveau de difficulté ;
  • au moins un bloc, sans bloc vide, sans image dépourvue de texte alternatif, et sans note de code à revoir.

Écrire un bon « En bref » : imaginez que vous l'expliquez à quelqu'un de curieux mais qui n'est pas du domaine. Dites ce que vous avez fait, sur quelle langue, et à quoi cela peut servir. Évitez les sigles, ou expliquez-les.

Une fois en ligne, vos modifications sont visibles dès l'enregistrement. L'adresse de la publication est figée à sa première publication. Vous pouvez la retirer à tout moment ; une publication retirée peut être supprimée.

8. Licences

Chaque publication indique deux licences, visibles en bas de page : une pour le texte (CC BY 4.0, CC BY-SA 4.0, CC BY-NC 4.0, CC0 (domaine public)) et une pour le code (MIT, Apache 2.0, GPL 3.0, BSD 3-Clause). Par défaut : CC BY 4.0 pour le texte et MIT pour le code, qui permettent la réutilisation à condition de citer l'auteur. Assurez-vous d'avoir le droit de publier les images et les données que vous utilisez, et citez vos sources.

9. Règles et modération

Les conditions d'utilisation interdisent notamment le plagiat, les contenus illicites ou haineux, le spam et le code malveillant. Tout membre peut signaler une publication. Si une publication est retirée par la modération, vous recevez le motif par email et dans votre éditeur ; vous pouvez la corriger puis la republier, et elle sera revérifiée.

Une question ? Écrivez-nous : komor.ia2025@gmail.com.

Documentation · Komor-IA Research