Comment bien définir Jupytext lors de la gestion du code en équipe

C'est pénible d'avoir quelqu'un d'autre éditer ~ / .jupyter / jupyter_notebook_config.py avec les paramètres de conversion automatique de jupytext. J'ai une bonne méthode de réglage donc je vais la partager.

Première conclusion

Placez un fichier avec le contenu suivant à la racine du projet.

jupytext.yml

default_jupytext_formats: "ipynb,py:percent"

Qu'est-ce que jupytext

jupytext est un outil qui convertit les fichiers .ipynb en .py, .R, .jl, .md, .Rmd, etc. En le définissant, il fonctionne avec jupyter lab et le convertit automatiquement lors de l'enregistrement d'un fichier. Il peut également être exécuté à partir de la ligne de commande, il est donc polyvalent.

Il existe un autre outil pour convertir en .ipynb-> .py, nbconvert, mais il est très nécessaire de le convertir automatiquement lors de la sauvegarde.

Conversion .ipynb <-> .py

L'analyse avec plusieurs personnes révélera les mauvais points de .ipynb. Il y a quelques

• C'est lourd à gérer git.
• Il est au format json et est difficile à lire au moment de la révision.

C'est difficile à partager. Une des solutions à cela est de le convertir au format python. Cela rend le portable léger et facile à lire, ce qui est agréable. Vous pouvez également reproduire le notebook sans aucun problème en convertissant .py-> .ipynb.

environnement

#Environnement Pipenv
python 3.8.5
jupyterlab 2.2.6

Procédure d'utilisation

1. Installation de jupytext

Si vous n'utilisez pas pipenv, remplacez-le par un bon.

$ pipenv install jupytext

2. Construisez le laboratoire Jupyter

Lorsque vous démarrez jupyter lab après l'installation, il vous sera demandé si vous voulez le compiler, alors compilez-le simplement. Si vous voulez construire manuellement, utilisez pipenv run jupyter lab build.

Comment régler

4 types de méthodes de réglage

Il existe quatre méthodes de réglage.

1. Modifiez les métadonnées .ipynb
2. jupytext --set-formats ipynb,py notebook.ipynb
3. Modifiez ~ / .jupyter / jupyter_notebook_config.py
4. Créez un fichier de configuration jupytext

1 et 2 doivent être définis pour chaque fichier, ce qui est gênant. Le fonctionnement ne peut pas être garanti pour 3 car il est nécessaire d'exploiter des fichiers en dehors du référentiel.

Cette fois, je vais expliquer le n ° 4. Cette méthode est douce car elle est déjà définie lorsque quelqu'un extrait le référentiel.

Créer un fichier de configuration

Créez un fichier de configuration avec l'un des noms suivants. .jupytext jupytext.toml jupytext.yml jupytext.yaml jupytext.json jupytext.py Ou le format avec «.» Ajouté au début de ces

Si vous placez ce fichier à la racine du projet, il sera lu automatiquement. Veuillez consulter le lien de référence pour plus de détails sur l'emplacement.

La conversion automatique sera effective en écrivant comme suit. Cette fois, je l'ai écrit en yaml.

jupytext.yml

default_jupytext_formats: "ipynb,py:percent"

Compte tenu de l'utilisation avec VSCode et PyCharm, le format py: percent est recommandé pour les fichiers python.

En conséquence, je pense que la structure des répertoires ressemblera à ceci.

.
├── Pipfile
├── Pipfile.lock
├── notebook.ipynb  #Cahier créé
├── notebook.py  #Python converti et généré
└── jupytext.yml  #fichier de configuration

Résumé

• La conversion .ipynb <-> .py facilite la gestion du code pour les équipes. --Jupytext peut être automatiquement converti lors de l'enregistrement d'un fichier.
• Il existe différentes façons de définir Jupytext --Facile à partager les paramètres à l'aide d'un fichier de paramètres --py: percent est sûr

c'est tout!

référence

Configuration — Jupytext documentation