Add additional platform page for third-party vendor (#2072)

This PR adds a new page for users to search for guidelines for more
PyTorch backends through the official website.

Author: can-gaa-hou

.github/workflows/update-quick-start-module.yml

@@ -7,16 +7,22 @@ on:
     paths:
       - .github/workflows/update-quick-start-module.yml
       - scripts/gen_quick_start_module.py
+      - scripts/gen_additional_platforms.py
       - _includes/quick-start-module.js
       - _includes/quick_start_local.html
+      - _additional_platforms/*.json
+      - _get_started/additional_platforms/*.md
   push:
     branches:
       site
     paths:
       - .github/workflows/update-quick-start-module.yml
       - scripts/gen_quick_start_module.py
+      - scripts/gen_additional_platforms.py
       - _includes/quick-start-module.js
       - _includes/quick_start_local.html
+      - _additional_platforms/*.json
+      - _get_started/additional_platforms/*.md
   workflow_dispatch:
 
 jobs:
@@ -116,3 +122,20 @@ jobs:
           body: >
             This PR is auto-generated. It updates Getting Started page
           labels: automated pr
+
+  update-additional-platform:
+    runs-on: "ubuntu-latest"
+    environment: pytorchbot-env
+    steps:
+      - name: Checkout pytorch.github.io
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: x64
+      - name: Generate quick-start-additional-platforms.js
+        shell: bash
+        run: |
+          set -ex
+          python3 ./scripts/gen_additional_platforms.py

README.md

@@ -92,3 +92,4 @@ PyTorch repo [README.md](https://github.com/pytorch/pytorch/blob/master/README.m
 * Information about contributing to PyTorch Tutorials can be found in the 
 tutorials [README.md](https://github.com/pytorch/tutorials/blob/master/README.md).
 * Additional contribution information can be found in [PyTorch CONTRIBUTING.md](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md).
+* To add additional accelerators to pytorch.org, please refer to [additional_platforms.md](additional_platforms.md).

_get_started/get-started-additional-platforms.md

@@ -0,0 +1,27 @@
+---
+layout: get_started
+title: Additional Platforms
+permalink: /get-started/additional-platforms/
+background-class: get-started-background
+body-class: get-started
+order: 1
+published: true
+get-started-additional: true
+---
+
+<div class="container-fluid quick-start-module quick-starts">
+  <div class="row">
+    <div class="col-md-12">
+      {% include quick_start_additional_platforms.html %}
+    </div>
+  </div>
+</div>
+
+---
+<div id="additional-platforms-installation">
+  <!-- Platform content divs will be dynamically created by JavaScript -->
+</div>
+
+<script page-id="get-started-additional-platforms" src="{{ site.baseurl }}/assets/menu-tab-selection.js"></script>
+<script src="{{ site.baseurl }}/assets/quick-start-additional-platforms.js"></script>
+<script src="{{ site.baseurl }}/assets/get-started-sidebar.js"></script>

_get_started/get-started-locally.md

@@ -20,6 +20,8 @@ redirect_from: "/get-started/"
   </div>
 </div>
 
+<p><i>Could not find the right platform for your hardware?</i> See the <a href="{{ site.baseurl }}/get-started/additional-platforms/">PyTorch Additional Platforms</a> page.</p>
+
 ---
 
 {% capture mac %}

_includes/quick-start-additional-platforms.js

@@ -0,0 +1,294 @@
+// =====================================================
+// Additional Platforms Quick Start Module
+// =====================================================
+
+// Platform data loaded from JSON files (generated by gen_additional_platforms.py)
+var ecosystemPlatformData = {{ platformData }};
+
+// HTML content loaded from _get_started/additional_platforms/ directory
+// (pre-converted by Python script with syntax highlighting)
+var ecosystemHtmlContent = {{ markdownContent }};
+
+// Get platform IDs from loaded data
+var ecosystemPlatformIds = Object.keys(ecosystemPlatformData);
+
+// Ecosystem platform selections - simplified (no pm, no version)
+var ecosystemOpts = {
+  build: 'stable',
+  os: 'linux',
+  platform: null
+};
+
+// Initialize additional platforms when document is ready
+$(function() {
+  initPlatformContentContainer();
+  initAdditionalPlatforms();
+  initAdditionalPlatformButtons();
+  updatePlatformButtonStates();
+  updateBuildButtonStates();
+  syncComputePlatformHeight();
+  initPlatformContentDisplay();
+});
+
+// Initialize platform content container - dynamically create divs for each platform
+function initPlatformContentContainer() {
+  var container = $('#additional-platforms-installation');
+  if (!container.length) return;
+  
+  // Clear any existing static content
+  container.empty();
+  
+  // Create platform content divs dynamically based on HTML content
+  ecosystemPlatformIds.forEach(function(platformId) {
+    if (ecosystemHtmlContent[platformId]) {
+      var contentDiv = $('<div class="platform-content ' + platformId + '"></div>');
+      // HTML content is already pre-converted with syntax highlighting
+      contentDiv.html(ecosystemHtmlContent[platformId]);
+      container.append(contentDiv);
+    }
+  });
+}
+
+// Note: Markdown is pre-converted to HTML by Python script (gen_additional_platforms.py)
+// using markdown library with codehilite extension for syntax highlighting.
+// No need for client-side markdown parsing.
+
+// Initialize platform content display - hide all initially
+function initPlatformContentDisplay() {
+  $('#additional-platforms-installation .platform-content').hide();
+}
+
+// Sync left heading height with right compute platform buttons height
+function syncComputePlatformHeight() {
+  var rightHeight = $('.compute-platform').outerHeight();
+  if (rightHeight > 0) {
+    $('.compute-platform-heading').css('min-height', rightHeight + 'px');
+  }
+}
+
+// Populate compute platform buttons
+function initAdditionalPlatformButtons() {
+  var platformRow = $('.compute-platform');
+  if (!platformRow.length) return;
+
+  // Generate platform buttons
+  ecosystemPlatformIds.forEach(function(platformId) {
+    var platform = ecosystemPlatformData[platformId];
+    if (!platform) return;
+    var displayName = platform.name;
+    var btn = $('<div class="col-md-3 option block" id="' + platformId + '"><div class="option-text">' + displayName + '</div></div>');
+    platformRow.append(btn);
+  });
+
+  // Sync height after buttons are generated
+  syncComputePlatformHeight();
+
+  // Bind platform button click
+  $('.compute-platform > .option').on('click', function() {
+    var platformId = this.id;
+    var platform = ecosystemPlatformData[platformId];
+    if (!platform) return;
+
+    // Check if supported on current OS
+    var supportedOS = getSupportedOS(platformId);
+    if (!supportedOS.includes(ecosystemOpts.os)) {
+      $('#command').html('<i>' + platform.name + ' is not supported on ' + ecosystemOpts.os + '</i>');
+      return;
+    }
+
+    // Select this platform
+    $('.compute-platform > .option').removeClass('selected');
+    $(this).addClass('selected');
+    ecosystemOpts.platform = platformId;
+
+    updateBuildButtonStates();
+    updateEcosystemCommand();
+    updatePlatformContentDisplay();
+  });
+}
+
+// Get supported OS list from platform data structure
+function getSupportedOS(platformId) {
+  var platform = ecosystemPlatformData[platformId];
+  if (!platform) return [];
+
+  var osSet = new Set();
+  ['stable', 'preview'].forEach(function(build) {
+    if (platform[build]) {
+      Object.keys(platform[build]).forEach(function(os) {
+        osSet.add(os);
+      });
+    }
+  });
+  return Array.from(osSet);
+}
+
+// Get supported build list for a platform
+function getSupportedBuilds(platformId) {
+  var platform = ecosystemPlatformData[platformId];
+  if (!platform) return [];
+  var builds = [];
+  if (platform.stable) builds.push('stable');
+  if (platform.preview) builds.push('preview');
+  return builds;
+}
+
+// Update platform button states (disabled/enabled) based on OS
+function updatePlatformButtonStates() {
+  $('.compute-platform > .option').each(function() {
+    var platformId = this.id;
+    if (!platformId) return;
+
+    var supportedOS = getSupportedOS(platformId);
+    var isSupported = supportedOS.includes(ecosystemOpts.os);
+
+    if (isSupported) {
+      $(this).css('text-decoration', '');
+    } else {
+      $(this).css('text-decoration', 'line-through');
+    }
+  });
+
+  // If currently selected platform is not supported on new OS, deselect it
+  if (ecosystemOpts.platform) {
+    var supportedOS = getSupportedOS(ecosystemOpts.platform);
+    if (!supportedOS.includes(ecosystemOpts.os)) {
+      ecosystemOpts.platform = null;
+      $('.compute-platform > .option').removeClass('selected');
+      $('#command').html('Select a compute platform to see the installation command.');
+      updatePlatformContentDisplay();
+    }
+  }
+}
+
+// Update build button states (disabled/enabled) based on selected platform
+function updateBuildButtonStates() {
+  $('.pytorch-build > .option').each(function() {
+    var buildId = this.id;
+    if (!buildId) return;
+
+    if (!ecosystemOpts.platform) {
+      // No platform selected - show all builds as available
+      $(this).css('text-decoration', '');
+      return;
+    }
+
+    var supportedBuilds = getSupportedBuilds(ecosystemOpts.platform);
+    var isSupported = supportedBuilds.includes(buildId);
+
+    if (isSupported) {
+      $(this).css('text-decoration', '');
+    } else {
+      $(this).css('text-decoration', 'line-through');
+    }
+  });
+
+  // If currently selected build is not supported by the platform, auto-switch to a supported build
+  if (ecosystemOpts.platform) {
+    var supportedBuilds = getSupportedBuilds(ecosystemOpts.platform);
+    if (!supportedBuilds.includes(ecosystemOpts.build)) {
+      // Switch to the first supported build
+      if (supportedBuilds.length > 0) {
+        ecosystemOpts.build = supportedBuilds[0];
+        $('.pytorch-build > .option').removeClass('selected');
+        $('.pytorch-build > .option#' + ecosystemOpts.build).addClass('selected');
+      }
+    }
+  }
+}
+
+// Update platform content display based on selected platform
+function updatePlatformContentDisplay() {
+  // Hide all platform content first
+  $('#additional-platforms-installation .platform-content').hide();
+  
+  // Show selected platform content
+  if (ecosystemOpts.platform) {
+    $('#additional-platforms-installation .platform-content.' + ecosystemOpts.platform).show();
+  }
+}
+
+// Initialize all click events for build/os blocks
+function initAdditionalPlatforms() {
+  // PyTorch Build - prevent selecting unsupported builds
+  $('.pytorch-build > .option').on('click', function() {
+    var buildId = this.id;
+    
+    // Check if this build is supported by the selected platform
+    if (ecosystemOpts.platform) {
+      var supportedBuilds = getSupportedBuilds(ecosystemOpts.platform);
+      if (!supportedBuilds.includes(buildId)) {
+        // Don't allow selecting unsupported build
+        return;
+      }
+    }
+
+    $('.pytorch-build > .option').removeClass('selected');
+    $(this).addClass('selected');
+    ecosystemOpts.build = buildId;
+    updateEcosystemCommand();
+  });
+
+  // OS - with platform support check
+  $('.os-ecosystem > .option').on('click', function() {
+    $('.os-ecosystem > .option').removeClass('selected');
+    $(this).addClass('selected');
+    ecosystemOpts.os = this.id;
+
+    updatePlatformButtonStates();
+    updateBuildButtonStates();
+    updateEcosystemCommand();
+  });
+}
+
+// Update ecosystem command based on selections - simplified
+function updateEcosystemCommand() {
+  if (!ecosystemOpts.platform) {
+    $('#command').html('Select a compute platform to see the installation command.');
+    $('#support-channel').html('Select a compute platform to see the support channel.');
+    return;
+  }
+
+  var platform = ecosystemPlatformData[ecosystemOpts.platform];
+  if (!platform) {
+    $('#command').html('Loading platform data...');
+    $('#support-channel').html('Loading platform data...');
+    return;
+  }
+
+  // Check if OS is supported
+  var supportedOS = getSupportedOS(ecosystemOpts.platform);
+  if (!supportedOS.includes(ecosystemOpts.os)) {
+    $('#command').html('<i>' + platform.name + ' is not supported on ' + ecosystemOpts.os + '</i>');
+    $('#support-channel').html('<i>Select a supported platform to see the support channel.</i>');
+    return;
+  }
+
+  // Get command directly from platform[build][os]
+  try {
+    var buildData = platform[ecosystemOpts.build];
+    if (!buildData || !buildData[ecosystemOpts.os]) {
+      $('#command').html('<i>Configuration not available for this combination</i>');
+      $('#support-channel').html('<i>Select a valid combination to see the support channel.</i>');
+      return;
+    }
+    
+    var cmd = buildData[ecosystemOpts.os];
+    
+    if (cmd) {
+      $('#command').html('<pre>' + cmd + '</pre>');
+    } else {
+      $('#command').html('<i>Configuration not available for this combination</i>');
+    }
+    
+    // Update support channel
+    if (platform.support_channel) {
+      $('#support-channel').html('<a href="' + platform.support_channel + '" target="_blank">' + platform.support_channel + '</a>');
+    } else {
+      $('#support-channel').html('<i>No support channel available for this platform.</i>');
+    }
+  } catch (e) {
+    $('#command').html('<i>Configuration not available for this combination</i>');
+    $('#support-channel').html('<i>Configuration not available</i>');
+  }
+}