Documentation NVSHMEM
Objectif
Trouver et résumer la documentation officielle NVSHMEM et NVSHMEM4Py sensible aux versions. Récupérer et citer les pages live les plus spécifiques ; ne pas formuler de claims techniques à partir de la mémoire, d'extraits de recherche ou de la topic map intégrée.
Prérequis
Exiger topic-map.md et un outil de récupération capable d'ouvrir la documentation HTTPS publique NVIDIA. Aucune clé API ni compte requis. Ne supporter que les versions NVSHMEM dont la version majeure est 3 ou ultérieure ; rejeter une version demandée inférieure à 3 avant de consulter la documentation.
Instructions
Lire la topic map pour chaque requête afin de résoudre le sujet et les pages candidates. L'utiliser uniquement pour le routage ; ce n'est pas une preuve.
Choisir l'édition de documentation
Normaliser un v initial optionnel. Utiliser latest quand aucune version n'est demandée. Pour une version MAJOR.MINOR.PATCH exacte, utiliser d'abord son archive. Remplacer le VERSION littéral dans chaque URL d'archive ci-dessous par la version NVSHMEM normalisée (par exemple, 3.7.1 devient https://archive.docs.nvidia.com/nvshmem/api/3.7.1/index.html) :
| Contenu | Latest | Archive version exacte |
|---|---|---|
| Référence API, concepts, utilisation et paramètres runtime | https://docs.nvidia.com/nvshmem/api/latest/ |
https://archive.docs.nvidia.com/nvshmem/api/VERSION/index.html |
| Notes de version, installation, bonnes pratiques et support | https://docs.nvidia.com/nvshmem/release-notes-install-guide/ |
https://archive.docs.nvidia.com/nvshmem/VERSION/index.html |
Pour une valeur MAJOR.MINOR, ne demander le patch que quand une édition archivée exacte est nécessaire. Commencer à la racine sélectionnée et suivre sa table des matières car les chemins internes peuvent différer entre les éditions. Pour les questions transversales, utiliser les deux ensembles de documentation de la même édition.
Quand une archive exacte est indisponible, inspecter la racine latest pertinente et ses informations officielles de version/release. Si elle identifie la version demandée comme la release actuelle, utiliser cette documentation latest et déclarer que la version demandée est servie depuis latest plutôt que depuis une archive. Si latest identifie une version différente, rapporter que l'archive demandée est indisponible ; offrir la documentation latest différente uniquement comme contexte actuel clairement étiqueté. Ne jamais utiliser silencieusement la documentation latest pour une autre version.
Récupérer et répondre
- Déduire le sujet et la version optionnelle de l'utilisateur ou de la skill d'invocation, puis le router avec la topic map.
- Ouvrir la racine appropriée ci-dessus et la page de sujet pertinente dans cette édition. Si une archive exacte est indisponible, résoudre si
latestest la version demandée avant de l'utiliser comme preuve. - Répondre brièvement avec des liens officiels directs. Énoncer la version de documentation quand une a été demandée ou quand l'applicabilité importe.
- Si une archive exacte ne peut pas être récupérée et latest est une version différente, le dire. Offrir le contexte latest clairement étiqueté uniquement s'il est utile.
Garder les réponses orientées utilisateur. Ne pas divulguer la mécanique interne de récupération ou les détails de sources tentées ; rapporter uniquement les conclusions, versions applicables, liens de preuve et incertitude matérielle.
Si les pages live ne peuvent pas être récupérées, renvoyer les liens racine appropriés, énoncer que leurs contenus n'ont pas été vérifiés et éviter les claims techniques soutenus par la documentation.
Traiter NVSHMEM4Py
Pour une requête NVSHMEM4Py sans version, utiliser la documentation latest. Si une version NVSHMEM est demandée, utiliser cette édition de documentation NVSHMEM sans résoudre la version du package NVSHMEM4Py. Uniquement quand une version NVSHMEM4Py ou une compatibilité de version est demandée, résoudre la paire de version indépendante depuis le guide de compatibilité live officiel—jamais l'inférer ou la coder en dur—et utiliser la version NVSHMEM résolue pour sélectionner une archive. Demander uniquement quand une version nue est ambiguë ou que plusieurs releases NVSHMEM correspondent.
Les gates de topic-map non préfixés s'appliquent à NVSHMEM. Préfixer un gate Python-only avec nvshmem4py:, le comparer uniquement avec la version NVSHMEM4Py et nommer l'axe de version dans la réponse.
Vérifier les gates de version
Quand une ligne topic-map routée a introduced_in ou removed_in, vérifier le gate depuis sa preuve officielle live et toujours le rapporter. Comparer les gates NVSHMEM par MAJOR.MINOR et les gates nvshmem4py: par la version complète du package. Rapporter une non-correspondance quand la version demandée est antérieure à introduced_in ou à/après removed_in ; sinon rapporter aucune non-correspondance. Utiliser une forme compacte telle que Version gate: introduced in 3.7; requested 3.5 — mismatch.
Ne pas effectuer une recherche de disponibilité plus large simplement parce qu'une version a été fournie. Ne le faire que quand l'utilisateur demande explicitement si une feature non-gatée ou un symbole exact est disponible, introduit, supprimé ou supporté. Ensuite inspecter l'archive demandée et les notes de version correspondantes. L'absence d'une page ou d'un résultat de recherche est inconclusive ; si la preuve n'est pas décisive, dire que la disponibilité n'a pas pu être établie.
Pour les conteneurs NVIDIA HPC SDK, utiliser le catalogue NGC officiel et la documentation HPC SDK pour les procédures de conteneurs. Ne pas inférer la version NVSHMEM intégrée à partir d'une balise d'image sauf si une page officielle le déclare.
Limitations
- La documentation ne prouve pas les binaires installés, le contenu des conteneurs, la configuration, le comportement runtime ou la performance.
- Une page, un symbole ou un résultat de recherche manquant ne prouve pas l'indisponibilité.
- Les réponses techniques exigent une preuve officielle live récupérée ; la topic map est uniquement un index de routage.
Dépannage
| Erreur | Cause | Solution |
|---|---|---|
| Échec de route topic-map | Documentation déplacée | Naviguer dans la table des matières live de l'édition sélectionnée. |
| Échec d'archive exacte | L'édition est indisponible, est la release actuelle non-archivée, ou la récupération a échoué | Inspecter latest pour identifier sa version. L'utiliser uniquement quand elle correspond à la requête ; sinon rapporter l'échec et l'offrir uniquement comme contexte actuel clairement étiqueté. |
| Version NVSHMEM demandée inférieure à 3.0 | Édition de documentation non supportée | Rejeter la requête ; ne pas chercher dans la documentation d'archive ou latest. |
| Version ambiguë | Composant non nommé | Demander s'il s'agit d'une version NVSHMEM ou NVSHMEM4Py. |
| Compatibilité non résolue | Aucune ligne de compatibilité live unique n'existe | Rapporter les candidats ou l'incertitude ; ne pas inférer une paire. |
Exemples
Use $nvshmem-docs to explain NVSHMEM_THREAD_SERIALIZED.
Use $nvshmem-docs to find NVSHMEM4Py installation documentation for NVSHMEM 3.5.21.
Use $nvshmem-docs to check whether NVSHMEM4Py 0.2.2 is compatible with NVSHMEM 3.6.5.
<!-- ci trigger -->