latest/doxygen/Gather_8hpp_source.html

// Copyright (c) 2019 Graphcore Ltd. All rights reserved.

#ifndef popops_Gather_hpp

#define popops_Gather_hpp

#include <poplar/Graph.hpp>

#include <poplar/Program.hpp>


namespace popops {


struct GatherParams {

  std::size_t maxElementsPerTile = 65535;


  GatherParams() = default;

  GatherParams(std::size_t maxElementsPerTile_)

      : maxElementsPerTile(maxElementsPerTile_) {}

};


poplar::Tensor createGatherInput(poplar::Graph &graph, const poplar::Type &type,

                                 const std::vector<std::size_t> &operandShape,

                                 unsigned axis, GatherParams params = {},

                                 const poplar::DebugContext &debugContext = {});


poplar::Tensor gather(poplar::Graph &graph, const poplar::Tensor &input,

                      const poplar::Tensor &indices, unsigned axis,

                      poplar::program::Sequence &prog, GatherParams params,

                      const poplar::DebugContext &debugContext = {});


poplar::Tensor createGatherInput(poplar::Graph &graph, const poplar::Type &type,

                                 const std::vector<std::size_t> &inputShape,

                                 const std::vector<std::size_t> &sliceSizes,

                                 std::vector<unsigned> startIndexMap,

                                 const poplar::DebugContext &debugContext = {});


poplar::Tensor gather(poplar::Graph &graph, const poplar::Tensor &input,

                      const poplar::Tensor &indices, std::size_t indexVectorDim,

                      const std::vector<std::size_t> &offsetDims,

                      const std::vector<std::size_t> &sliceSizes,

                      const std::vector<std::size_t> &collapsedSliceDims,

                      const std::vector<unsigned> &startIndexMap,

                      poplar::program::Sequence &prog,

                      const poplar::DebugContext &debugContext = {});


} // namespace popops


#endif // popops_DynamicSlice_hpp

poplar::DebugContext
DebugContext gathers the common external parameters of the context of an operation.
Definition: DebugContext.hpp:221

poplar::Graph
This class represents a graph program to be executed on the IPU.
Definition: Graph.hpp:52

poplar::Tensor
A reference to a subset of tensor elements.
Definition: Tensor.hpp:38

poplar::Type
Class representing device data types.
Definition: Type.hpp:42

poplar::program::Sequence
Program that executes a sequence of programs.
Definition: Program.hpp:77

popops
Common functions, such as elementwise and reductions.
Definition: AllTrue.hpp:15

popops::createGatherInput
poplar::Tensor createGatherInput(poplar::Graph &graph, const poplar::Type &type, const std::vector< std::size_t > &operandShape, unsigned axis, GatherParams params={}, const poplar::DebugContext &debugContext={})
Create the input of the gather with only a single gather axis.

popops::gather
poplar::Tensor gather(poplar::Graph &graph, const poplar::Tensor &input, const poplar::Tensor &indices, unsigned axis, poplar::program::Sequence &prog, GatherParams params, const poplar::DebugContext &debugContext={})
The gather operation stitches together several slices (each slice at a potentially different runtime ...

popops::GatherParams
Defines the parameters to a gather operation.
Definition: Gather.hpp:16

popops::GatherParams::maxElementsPerTile
std::size_t maxElementsPerTile
Suggested maximum number of elements to place on a tile.
Definition: Gather.hpp:19