Newsletter 2 - Objectif concept !, BTOP et économie

Hello, et bienvenue dans cette nouvelle newsletter !

Mes idées du moment

J'aime bien coder, et une question me travail de plus en plus : comment gérer les documentations manquantes ? C'est un vrai problème car très courant, et sur des packages clés (exemple : Langchain, package clé de l'IA dans Python qui n'a aucune doc' hors ligne dispo). Quand je parle de documentation, je parle d'un docset extractible pour être chargé dans un logiciel dédié de documentation de package tel que Zeal ou Dash. Je ne comprend pas le modèle des entreprises qui développent ces packages.

Je code en python exclusivement. J'aime toucher à tout, du web au jeux vidéos en passant par les données, et Python est le trade-off parfait pour moi (excellent nulle part sinon en IA, mais bon partout).

Pourquoi je veux avoir une doc' ? La doc' est un élément centrale du codeur : personne ne connait par cœur toutes les options de toutes les fonctions d'un package, ça sert à rien. De plus aujourd'hui, personne n'utilise 1 package, nous en utilisons tous plusieurs, il faut donc avoir l'info dans un format facile à requêter et lisible, c'est le but de la documentation et des logiciels associés.

Cette réflexion me pousse aussi identifier les limites des documentations actuelles : les documentations actuelles sont un ensemble de description de fonctions version spécifique d'un package. Certaines documentations comme Pandas propose des petits tutoriels pour prendre en main le package.

Mais un problème majeur demeure : il est impossible de créer soit même ses propres guides et de les ajouter au packages.

Pour être plus précis, voici mon idée:

• Pouvoir créer ses propres guides

• Lors de l'intégration du guide à la documentation du package :

  • Le logiciel lit les les fonctions utilisées dans le guide et identifie à l'aide des imports réalisés quelle fonction du guide est associée à quel package. En cas de doute, le logiciel demande à l'utilisateur de préciser la fonction donnée. En backend, le logiciel pourrait associer un package à chaque fonction citée du guide via des métadatas fonction-spécifique, et le développeur peut retoucher s'il le souhaite,

  • Lorsque l'utilisateur passe sa souris sur une fonction dans la documentation classique, une liste flottante de liens apparait vers l'ensemble des guides qui utilise cette fonction

  • Lorsque l'utilisateur passe sa souris sur une fonction dans un guide, une liste flottante de liens apparait, avec en rouge les versions de packages pour lesquels la fonction n'existe pas (si des documentations de plusieurs versions d'un même package sont installés), et en vert les versions de packages pour les lesquels la fonction existe avec un lien cliquable pointant vers la documentation classique de la-dite fonction.

• Les guides doivent pouvoir s'importer et s'exporter, dans un format utilisant des normes open source, pour que ces derniers puissent être partagé sur internet. Chaque utilisateur peut alors créer, soit à la main soit en les récupérant, sa propre guidothèque de code !

Cette manière de documenter peut sembler compliqué voir trop compliqué, mais à l'heure de l'explosion du knowledge management, je trouve que c'est un standard raisonnable à atteindre.

Ce projet nécessite des compétences en code que je n'ai pas (encore), je ne baisse donc pas les bras, mais le projet va être pharaonique pour le non-dev que je suis !

Mon mood et mes actus du moment

J'ai eu une grosse phase de production d'articles jusqu'à mi-mai, j'écrivais beaucoup d'articles (probablement l'impact des ponts et du temps libre qui va avec). Depuis mi-mai, j'ai plus de mal à me remettre à écrire, chaque semaine j'écris 1 article pour la semaine prochaine, sans avoir trop ni le courage ni l'inspiration d'en attaquer un autre, donc je travaille en flux tendu, je suis donc moins à l'aise de tenir mon engagement de publier 1 article par semaine. On verra après tout !

J'ai trouvé et repris une formation sur la prise de note il y a quelques jours, et je me rends de plus en plus compte de son impact : depuis que je l'ai fini, je n'ai de cesse de simplifier mon coffre de connaissance et de faire des mindmaps quand ça s'y prête à la place de fichiers de longueur infinie avec une table des matières automatique. Et j'avoue que ça marche assez bien, je me suis repenché sur des concepts qui trainaient dans ma tête mais pour lesquels je n'avais jamais réussi à voir dans mon vault ce que j'avais. C'est une preuve que les modif' que je fais fonctionnent, je trouve ça cool ! Je me suis aussi lancé le défi personnel de vraiment prendre des notes orienté concept, et pas de m'arrêter au milieu du gué comme je le faisais jusqu'à maintenant.

Mon logiciel du moment

• Btop : c'est un logiciel pour suivre seconde par seconde tout ce qui se passe sur votre ordinateur : mémoire, wifi, processeur. De 1, ça donne un petit coté hackeur avec un affichage type CLI qui bouge sans cesse ! de 2, l'outil est vraiment puissant pour suivre ce qui se passe sur votre ordi, voir les processus en cours, quand votre PC lance ses ventilos au max pour quelle raison.
  Pour les windowsien, le logiciel est évidement installable via Scoop (scoop install btop, et pour le lancer : btop)
  Lien vers le GitHub et article de Korben.
• GOG : je joue un peu aux jeux vidéos, et quelque chose m'a toujours sidéré dans ce milieu : la caducité extrêmement rapide des gens du fait de l'évolution des ordinateurs. GOG fait un travail remarquable, de reprendre des anciens jeu et de les retravailler pour les rendre rejouable sans problème de config'. Je trouve que c'est un petit miracle, qui m'a permis de rédécouvrir des bons jeux !
• Un peu plus inavouable : Playing with fire 2 : c'est un bomberman plus récent et plutôt rapide. J'y joué petit, puis je suis retombé dessus récemment, ça fait plaisir !

Je regarde aussi Podman (une version rootless de Docker) et MiniKube en ce moment, une version légère de Kubernetes installable et utilisable en local. Aujourd'hui les containers ne se suffisent plus à eux même, il faut en lancer plusieurs d'un coup pour une application, et savoir les gérer. MiniKube permet justement de mettre le pied à l'étrier sur son ordi. Pour être honnête, j'aimerai bien avoir plus de temps pour explorer ce logiciel (en réalité, je passe beaucoup de temps à faire autre chose, je peine à me concentrer, j'adore apprendre mais la phase de déconstruction de mes notes de référence en note littéraire m'est encore un peu difficile, faut donc que je continue à me mettre un coup de pied au cul pour faire tourner mon second cerveau, le pire est que je sais que ça vaut le cout !).

Mon livre du moment

Je comprends pas grand chose à l'économie, du coup je suis tombé sur ce livre : Tout sur l'économie, ou presque qui me parait prometteur. Je verrai.

J'espère que cette newsletter vous aura plu.

A très vite 🙂