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

DataStream

#include <poplar/DataStream.hpp>

namespace poplar

Poplar classes and functions.

class DataStream

#include <DataStream.hpp>

An object representing a stream for communicating between the host and the device.

A stream is a unidirectional communication from the host to the device, or from the device to the host.

The maximum buffer size for each stream is 128 MBytes.

See also

Graph::addHostToDeviceFIFO Graph.addDeviceToHostFIFO

Public Functions

DataStream()

DataStream(const DataStream&)

DataStream(DataStream&&) noexcept

~DataStream()

DataStream &operator=(const DataStream&)

DataStream &operator=(DataStream&&) noexcept

std::string handle() const

std::size_t numElements() const

unsigned replicationFactor() const

ReplicatedStreamMode replicatedMode() const

DataStreamType type() const

Type elementType() const

DataStream(std::unique_ptr<core::DataStreamRef>)

inline const core::DataStreamRef &getImpl() const

Private Members

std::unique_ptr<core::DataStreamRef> impl

class RemoteBuffer

#include <DataStream.hpp>

A remote buffer is a region of remote (meaning not on the IPU) memory that is used as a cache.

It is implemented as two DataStreams: one to write to the remote memory, the other to read the data back to the IPU.

Public Functions

RemoteBuffer()

RemoteBuffer(const RemoteBuffer&)

RemoteBuffer(RemoteBuffer&&) noexcept

~RemoteBuffer()

RemoteBuffer &operator=(const RemoteBuffer&)

RemoteBuffer &operator=(RemoteBuffer&&) noexcept

std::string handle() const

DataStream getIpuToHostStream() const

DataStream getHostToIpuStream() const

size_t numElements() const

size_t getRepeats() const

Type elementType() const

bool isRearrangeOnHost() const

bool isOptimisedForMemory() const

RemoteBuffer(std::unique_ptr<core::RemoteBufferRef>)

inline const core::RemoteBufferRef &getImpl() const

bool operator==(const RemoteBuffer &b) const

bool operator!=(const RemoteBuffer &b) const

Private Members

std::unique_ptr<core::RemoteBufferRef> impl

namespace core