Cette page concerne la soumission d'une demande d'extraction contenant des fichiers de documentation Markdown à tensorflow/tfhub.dev . Dépôt GitHub. Pour plus d'informations sur la façon d'écrire les fichiers Markdown en premier lieu, veuillez consulter le guide de documentation d'écriture .
Vérifications des actions GitHub
Le référentiel tensorflow/tfhub.dev utilise les actions GitHub pour valider le format des fichiers dans un PR. Le workflow utilisé pour valider les PR est défini dans .github/workflows/contributions-validator.yml . Vous pouvez exécuter le script de validation sur votre propre branche en dehors du flux de travail, mais vous devrez vous assurer que toutes les dépendances de package pip correctes sont installées.
Les nouveaux contributeurs ne peuvent exécuter des vérifications automatisées qu'avec l'approbation d'un responsable du référentiel, conformément à la politique GitHub . Les éditeurs sont encouragés à soumettre un petit PR corrigeant les fautes de frappe, sinon à améliorer la documentation du modèle ou à soumettre un PR contenant uniquement leur page d'éditeur en tant que premier PR pour pouvoir exécuter des vérifications automatisées sur les PR suivants.
Soumettre le PR
Les fichiers Markdown complets peuvent être extraits dans la branche principale de tensorflow/tfhub.dev par l'une des méthodes suivantes.
Soumission de la CLI Git
En supposant que le chemin du fichier de démarque identifié est assets/docs/publisher/model/1.md , vous pouvez suivre les étapes standard de Git[Hub] pour créer une nouvelle demande d'extraction avec un fichier nouvellement ajouté.
Cela commence par bifurquer le référentiel TensorFlow Hub GitHub, puis créer une demande d'extraction à partir de cette bifurcation dans la branche principale de TensorFlow Hub.
Voici les commandes git typiques de la CLI nécessaires pour ajouter un nouveau fichier à une branche principale du référentiel forké.
git clone https://github.com/[github_username]/tfhub.dev.git
cd tfhub.dev
mkdir -p assets/docs/publisher/model
cp my_markdown_file.md ./assets/docs/publisher/model/1.md
git add *
git commit -m "Added model file."
git push origin master
Soumission de l'interface graphique GitHub
Une façon un peu plus simple de soumettre est via l'interface utilisateur graphique GitHub. GitHub permet de créer des PR pour de nouveaux fichiers ou des modifications de fichiers directement via l'interface graphique.
- Sur la page GitHub de TensorFlow Hub , appuyez sur le bouton
Create new file. - Définissez le bon chemin de fichier :
assets/docs/publisher/model/1.md - Copiez-collez la démarque existante.
- En bas, sélectionnez "Créer une nouvelle branche pour ce commit et lancer une pull request".