Logo
GCL User Guide and API Reference
Version: latest
  • 1. Introduction
  • 2. Terminology and concepts
  • 3. Collectives
    • 3.1. Supported reduction operators
      • 3.1.1. ADD
      • 3.1.2. MEAN
      • 3.1.3. MUL
      • 3.1.4. MIN
      • 3.1.5. MAX
      • 3.1.6. SQUARE_ADD
      • 3.1.7. LOGICAL_AND
      • 3.1.8. LOGICAL_OR
    • 3.2. Collective groups
      • 3.2.1. Orthogonal group
      • 3.2.2. Consecutive group
      • 3.2.3. All group
    • 3.3. Collective operations
      • 3.3.1. AllGather
      • 3.3.2. AllReduce
      • 3.3.3. AllToAll
      • 3.3.4. Broadcast
      • 3.3.5. ReduceScatter
    • 3.4. Collective methods
      • 3.4.1. Anticlockwise ring
      • 3.4.2. Bi-directional ring pair
      • 3.4.3. Broadcast
      • 3.4.4. Clockwise ring
      • 3.4.5. Meet-in-the-middle ring
      • 3.4.6. Quad-directional ring
  • 4. Setting options
    • 4.1. Environment variables
      • 4.1.1. Option values
      • 4.1.2. Logging
      • 4.1.3. Graph generation
  • 5. Example code and usage
    • 5.1. Linking
    • 5.2. Example code
  • 6. C++ API reference
    • 6.1. CollectiveBalancedReorder
    • 6.2. Collectives
    • 6.3. TileAllocation
  • 7. Index
  • 8. Legal notices
GCL User Guide and API Reference

Search help

Note: Searching from the top-level index page will search all documents. Searching from a specific document will search only that document.

  • Find an exact phrase: Wrap your search phrase in "" (double quotes) to only get results where the phrase is exactly matched. For example "PyTorch for the IPU" or "replicated tensor sharding"
  • Prefix query: Add an * (asterisk) at the end of any word to indicate a prefix query. This will return results containing all words with the specific prefix. For example tensor*
  • Fuzzy search: Use ~N (tilde followed by a number) at the end of any word for a fuzzy search. This will return results that are similar to the search word. N specifies the “edit distance” (fuzziness) of the match. For example Polibs~1
  • Words close to each other: ~N (tilde followed by a number) after a phrase (in quotes) returns results where the words are close to each other. N is the maximum number of positions allowed between matching words. For example "ipu version"~2
  • Logical operators. You can use the following logical operators in a search:
    • + signifies AND operation
    • | signifies OR operation
    • - negates a single word or phrase (returns results without that word or phrase)
    • () controls operator precedence

GCL User Guide and API Reference

  • 1. Introduction
  • 2. Terminology and concepts
  • 3. Collectives
    • 3.1. Supported reduction operators
      • 3.1.1. ADD
      • 3.1.2. MEAN
      • 3.1.3. MUL
      • 3.1.4. MIN
      • 3.1.5. MAX
      • 3.1.6. SQUARE_ADD
      • 3.1.7. LOGICAL_AND
      • 3.1.8. LOGICAL_OR
    • 3.2. Collective groups
      • 3.2.1. Orthogonal group
      • 3.2.2. Consecutive group
      • 3.2.3. All group
    • 3.3. Collective operations
      • 3.3.1. AllGather
      • 3.3.2. AllReduce
      • 3.3.3. AllToAll
      • 3.3.4. Broadcast
      • 3.3.5. ReduceScatter
    • 3.4. Collective methods
      • 3.4.1. Anticlockwise ring
      • 3.4.2. Bi-directional ring pair
      • 3.4.3. Broadcast
      • 3.4.4. Clockwise ring
      • 3.4.5. Meet-in-the-middle ring
      • 3.4.6. Quad-directional ring
  • 4. Setting options
    • 4.1. Environment variables
      • 4.1.1. Option values
      • 4.1.2. Logging
      • 4.1.3. Graph generation
  • 5. Example code and usage
    • 5.1. Linking
    • 5.2. Example code
  • 6. C++ API reference
    • 6.1. CollectiveBalancedReorder
    • 6.2. Collectives
    • 6.3. TileAllocation
  • 7. Index
  • 8. Legal notices
Next

Revision 31c34a7c.