Intel(R) SHMEM Library (ISHMEM) 1.3.0 doc pages

Signed-off-by: sys_shmem <[email protected]>

Author: sys-shmem

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Intel Corporation.
+Copyright (c) 2024 Intel Corporation.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

docs/_sources/compiling_and_running_programs.rst

@@ -44,3 +44,29 @@ Intel® SHMEM build configuration::
 
 See section :ref:`Library Constants<library_constants>` for more information
 about these variables.
+
+Selecting SPIR-V Compilation Targets
+------------------------------------
+
+On some systems, you may encounter an error in which the correct SPIR-V targets
+are not successfully selected when linking with Intel® SHMEM.  This may result in
+problems when using device-initiated communication including compilation
+warnings: ::
+
+    icpx: warning: linked binaries do not contain expected 'spir64-unknown-unknown' target; found targets: 'spir64_gen-unknown-unknown' [-Wsycl-target]
+
+as well as runtime errors: ::
+
+    terminate called after throwing an instance of 'sycl::_V1::compile_program_error'
+      what():  The program was built for 1 devices
+    Build program log for 'Intel(R) Data Center GPU Max 1550':
+    Module <0x29941d0>:  Unresolved Symbol <_Z13ishmem_putmemPvPKvmi>
+    Module <0x29941d0>:  Unresolved Symbol <_Z13ishmem_putmemPvPKvmi>
+    Module <0x29941d0>:  Unresolved Symbol <_Z13ishmem_putmemPvPKvmi>
+    Module <0x29941d0>:  Unresolved Symbol <_Z13ishmem_putmemPvPKvmi> -11 (PI_ERROR_BUILD_PROGRAM_FAILURE)
+
+This error can be resolved by indicating the desired target at compile time. To
+compile with the appropriate target for a Intel® Data Center GPU Max 1550 (PVC)
+GPU, add the following flags when linking: ::
+
+    -fsycl-targets=spir64_gen --start-no-unused-arguments -Xs "-device pvc" --end-no-unused-arguments --start-no-unused-arguments -Xsycl-target-backend "-q" --end-no-unused-arguments

docs/_sources/library_setup_exit_query.rst

@@ -50,24 +50,27 @@ Callable from the **host**.
 Indicates which runtime is used to initialize Intel® SHMEM: either
 OpenSHMEM, MPI, or PMI.
 
-.. important:: As of Intel® SHMEM |version| only ISHMEM_RUNTIME_OPENSHMEM is supported.
+.. important:: As of Intel® SHMEM |version| only ISHMEM_RUNTIME_OPENSHMEM and ISHMEM_RUNTIME_MPI are supported.
 
 .. _ishmemx_attr_t:
 .. cpp:struct:: ishmemx_attr_t
 
   .. c:var:: ishmemx_runtime_type_t runtime
   .. c:var:: bool initialize_runtime = true
   .. c:var:: bool gpu = true
+  .. c:var:: void *mpi_comm
 
 **Description:**
 A struct declaration describing attributes for initialization.
 A valid **runtime** enumeration value must be set by the user and must
 correspond to a runtime that is enabled within the build of the ``ishmem``
 library.
-By default, the parallel runtime is assumed to be initialized by the user
-(**initialize_runtime** default is ``false``).
+By default, the parallel runtime is initialized by Intel® SHMEM
+(**initialize_runtime** default is ``true``).
 The **gpu** boolean indicates whether to use GPU memory for the symmetric
-heap (default is ``false``).
+heap (default is ``true``). **mpi_comm** is a pointer to the corresponding
+MPI communicator for representing ``ISHMEM_TEAM_WORLD`` when used with
+``ISHMEM_RUNTIME_MPI`` (default is ``MPI_COMM_WORLD``).
 
 .. _ishmemx_init_attr:
 .. cpp:function:: void ishmemx_init_attr(ishmemx_attr_t * attr)

docs/_sources/writing_programs.rst

@@ -4,9 +4,8 @@
 Writing Intel® SHMEM Programs
 ========================================
 
-Intel® SHMEM Programs require including the following header files::
+Intel® SHMEM Programs require including the following header file::
 
-#include <CL/sycl.hpp>
 #include <ishmem.h>
 
 Here is how to :ref:`initialize<library_setup_exit_query_routines>` the

docs/_static/basic.css

@@ -1,12 +1,5 @@
 /*
- * basic.css
- * ~~~~~~~~~
- *
  * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 /* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
+    margin-top: 10px;
 }
 
 ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
+    padding: 5px 0;
 }
 
 ul.search li a {
@@ -237,6 +226,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +663,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;

docs/_static/doctools.js

@@ -1,12 +1,5 @@
 /*
- * doctools.js
- * ~~~~~~~~~~~
- *
  * Base JavaScript utilities for all Sphinx HTML documentation.
- *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 "use strict";
 

docs/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.2.0',
+    VERSION: '1.3.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/_static/language_data.js

@@ -1,19 +1,12 @@
 /*
- * language_data.js
- * ~~~~~~~~~~~~~~~~
- *
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
- *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 
 /**
  * Porter Stemmer

docs/_static/locales/ar/LC_MESSAGES/booktheme.po

@@ -8,68 +8,68 @@ msgstr ""
 "Language: ar\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "suggest edit"
-msgstr "أقترح تحرير"
+msgid "By the"
+msgstr "بواسطة"
 
-msgid "Last updated on"
-msgstr "آخر تحديث في"
+msgid "By"
+msgstr "بواسطة"
+
+msgid "Contents"
+msgstr "محتويات"
+
+msgid "Copyright"
+msgstr "حقوق النشر"
+
+msgid "Download notebook file"
+msgstr "تنزيل ملف دفتر الملاحظات"
+
+msgid "Download source file"
+msgstr "تنزيل ملف المصدر"
+
+msgid "Download this page"
+msgstr "قم بتنزيل هذه الصفحة"
 
 msgid "Edit this page"
 msgstr "قم بتحرير هذه الصفحة"
 
+msgid "Fullscreen mode"
+msgstr "وضع ملء الشاشة"
+
+msgid "Last updated on"
+msgstr "آخر تحديث في"
+
 msgid "Launch"
 msgstr "إطلاق"
 
+msgid "Open an issue"
+msgstr "افتح قضية"
+
 msgid "Print to PDF"
 msgstr "طباعة إلى PDF"
 
-msgid "open issue"
-msgstr "قضية مفتوحة"
-
-msgid "Download notebook file"
-msgstr "تنزيل ملف دفتر الملاحظات"
-
-msgid "Toggle navigation"
-msgstr "تبديل التنقل"
-
 msgid "Source repository"
 msgstr "مستودع المصدر"
 
-msgid "By the"
-msgstr "بواسطة"
-
-msgid "next page"
-msgstr "الصفحة التالية"
-
-msgid "repository"
-msgstr "مخزن"
-
 msgid "Sphinx Book Theme"
 msgstr "موضوع كتاب أبو الهول"
 
-msgid "Download source file"
-msgstr "تنزيل ملف المصدر"
-
-msgid "Contents"
-msgstr "محتويات"
-
-msgid "By"
-msgstr "بواسطة"
+msgid "Theme by the"
+msgstr "موضوع بواسطة"
 
-msgid "Copyright"
-msgstr "حقوق النشر"
+msgid "Toggle navigation"
+msgstr "تبديل التنقل"
 
-msgid "Fullscreen mode"
-msgstr "وضع ملء الشاشة"
+msgid "next page"
+msgstr "الصفحة التالية"
 
-msgid "Open an issue"
-msgstr "افتح قضية"
+msgid "open issue"
+msgstr "قضية مفتوحة"
 
 msgid "previous page"
 msgstr "الصفحة السابقة"
 
-msgid "Download this page"
-msgstr "قم بتنزيل هذه الصفحة"
+msgid "repository"
+msgstr "مخزن"
 
-msgid "Theme by the"
-msgstr "موضوع بواسطة"
+msgid "suggest edit"
+msgstr "أقترح تحرير"

docs/_static/locales/bg/LC_MESSAGES/booktheme.po

@@ -8,68 +8,68 @@ msgstr ""
 "Language: bg\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "suggest edit"
-msgstr "предложи редактиране"
+msgid "By the"
+msgstr "По"
 
-msgid "Last updated on"
-msgstr "Последна актуализация на"
+msgid "By"
+msgstr "От"
+
+msgid "Contents"
+msgstr "Съдържание"
+
+msgid "Copyright"
+msgstr "Авторско право"
+
+msgid "Download notebook file"
+msgstr "Изтеглете файла на бележника"
+
+msgid "Download source file"
+msgstr "Изтеглете изходния файл"
+
+msgid "Download this page"
+msgstr "Изтеглете тази страница"
 
 msgid "Edit this page"
 msgstr "Редактирайте тази страница"
 
+msgid "Fullscreen mode"
+msgstr "Режим на цял екран"
+
+msgid "Last updated on"
+msgstr "Последна актуализация на"
+
 msgid "Launch"
 msgstr "Стартиране"
 
+msgid "Open an issue"
+msgstr "Отворете проблем"
+
 msgid "Print to PDF"
 msgstr "Печат в PDF"
 
-msgid "open issue"
-msgstr "отворен брой"
-
-msgid "Download notebook file"
-msgstr "Изтеглете файла на бележника"
-
-msgid "Toggle navigation"
-msgstr "Превключване на навигацията"
-
 msgid "Source repository"
 msgstr "Хранилище на източника"
 
-msgid "By the"
-msgstr "По"
-
-msgid "next page"
-msgstr "Следваща страница"
-
-msgid "repository"
-msgstr "хранилище"
-
 msgid "Sphinx Book Theme"
 msgstr "Тема на книгата Sphinx"
 
-msgid "Download source file"
-msgstr "Изтеглете изходния файл"
-
-msgid "Contents"
-msgstr "Съдържание"
-
-msgid "By"
-msgstr "От"
+msgid "Theme by the"
+msgstr "Тема от"
 
-msgid "Copyright"
-msgstr "Авторско право"
+msgid "Toggle navigation"
+msgstr "Превключване на навигацията"
 
-msgid "Fullscreen mode"
-msgstr "Режим на цял екран"
+msgid "next page"
+msgstr "Следваща страница"
 
-msgid "Open an issue"
-msgstr "Отворете проблем"
+msgid "open issue"
+msgstr "отворен брой"
 
 msgid "previous page"
 msgstr "предишна страница"
 
-msgid "Download this page"
-msgstr "Изтеглете тази страница"
+msgid "repository"
+msgstr "хранилище"
 
-msgid "Theme by the"
-msgstr "Тема от"
+msgid "suggest edit"
+msgstr "предложи редактиране"